CLI commands

Snapshot Templates commands

The 2 koast CLI commands for the Snapshot Templates operations.

Every command is one API operation, named by its operationId. Global flags such as --output and --api-url work on all of them, see CLI commands.

delete-snapshot-template

Delete campaign snapshot template. DELETE /v1/brands/{brandId}/snapshot-templates/{templateId}, API reference.

koast delete-snapshot-template --brand <brand> --template-id <template-id>
FlagTypeRequiredDescription
--brandintegerYesThe brand the request acts on. Every brand-scoped resource lives under its brand.
--template-idstringYesID of the template to delete

Required scope: write.

Example:

koast delete-snapshot-template --brand 123 --template-id TEMPLATE_ID

list-snapshot-templates

List campaign snapshot templates. GET /v1/brands/{brandId}/snapshot-templates, API reference.

koast list-snapshot-templates --brand <brand> [flags]
FlagTypeRequiredDescription
--brandintegerYesThe brand the request acts on. Every brand-scoped resource lives under its brand.
--cursorstringNoOpaque cursor from the previous page's nextCursor. Omit for the first page.
--limitintegerNoPage size. Default 50. Minimum 1, maximum 100.

Required scope: read. Paged. --all follows nextCursor to the end and prints one JSON line per item.

Example:

koast list-snapshot-templates --brand 123

On this page