Pipeline commands
The 4 koast CLI commands for the Pipeline 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.
configure-pipeline-column
Configure pipeline column. PATCH /v1/brands/{brandId}/pipeline/columns/{columnId}, API reference.
koast configure-pipeline-column --brand <brand> --column-id <column-id> [--json <file|->] [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--column-id | integer | Yes | |
--name | string | No | At most 32 characters. |
--is-hidden | boolean | No | |
--bind-template | JSON object | No | Bind a structure template to apply when a card enters this column. columnOverrides must cover the template's required deferred assets per account. |
Required scope: write. --json <file|-> supplies the whole body. Body flags are applied over it.
Example:
koast configure-pipeline-column --brand 123 --column-id 1create-pipeline-ticket
Create pipeline card. POST /v1/brands/{brandId}/pipeline/tickets, API reference.
koast create-pipeline-ticket --brand <brand> --title <title> [--json <file|->] [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--title | string | Yes | At most 500 characters. |
--stage | string | No | One of REQUESTED, ASSETS_UPLOADED, IN_REVIEW, APPROVED, FAILED. |
--creative-ids | integer, repeatable | No | |
--assignee-ids | integer, repeatable | No | |
--description | string | No | At most 2000 characters. |
Required scope: write. Accepts --idempotency-key. The CLI sends a key only when you give one. --json <file|-> supplies the whole body. Body flags are applied over it.
Example:
koast create-pipeline-ticket --brand 123 --title TITLElist-pipeline-columns
List pipeline columns. GET /v1/brands/{brandId}/pipeline/columns, API reference.
koast list-pipeline-columns --brand <brand> [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--cursor | string | No | Opaque cursor from the previous page's nextCursor. Omit for the first page. |
--limit | integer | No | Page 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-pipeline-columns --brand 123move-pipeline-card
Move pipeline card. POST /v1/brands/{brandId}/pipeline/cards/move, API reference.
koast move-pipeline-card --brand <brand> --stage <stage> [--json <file|->] [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--campaign-launch-id | string | No | The pipeline card (batch) id to move. |
--stage | string | Yes | One of REQUESTED, ASSETS_UPLOADED, IN_REVIEW, APPROVED, FAILED. |
Required scope: write. Accepts --idempotency-key. The CLI sends a key only when you give one. --json <file|-> supplies the whole body. Body flags are applied over it.
Example:
koast move-pipeline-card --brand 123 --stage REQUESTED