Buildkite CLI queue command

The bk queue command allows you to manage cluster queues from the command line.

Commands

Command Description
bk queue list List cluster queues.
bk queue view View a cluster queue.
bk queue create Create a new cluster queue.
bk queue update Update a cluster queue.
bk queue delete Delete a cluster queue.
bk queue pause Pause dispatch for a cluster queue.
bk queue resume Resume dispatch for a cluster queue.

List queues

List cluster queues.

bk queue list <cluster-uuid> [flags]

Arguments

Argument Description
<cluster-uuid> Cluster UUID to list queues for

Flags

Flag Description
-o, --output="" Output format. One of: json, yaml, text
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--json Output as JSON
--limit=100 Maximum number of queues to return
--org=STRING Organization slug for this invocation (overrides environment and configuration)
--per-page=30 Number of queues per page
--text Output as text
--yaml Output as YAML

Examples

List all queues for a cluster:

bk queue list my-cluster-uuid

Return more queues:

bk queue list my-cluster-uuid --limit 200

List in JSON format:

bk queue list my-cluster-uuid -o json

View a queue

View a cluster queue.

bk queue view <cluster-uuid> <queue-uuid> [flags]

Arguments

Argument Description
<cluster-uuid> Cluster UUID the queue belongs to
<queue-uuid> Queue UUID to view

Flags

Flag Description
-o, --output="" Output format. One of: json, yaml, text
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--json Output as JSON
--org=STRING Organization slug for this invocation (overrides environment and configuration)
--text Output as text
--yaml Output as YAML

Examples

View a queue:

bk queue view my-cluster-uuid my-queue-uuid

View a queue in JSON format:

bk queue view my-cluster-uuid my-queue-uuid -o json

Create a queue

Create a new cluster queue.

bk queue create --key=STRING <cluster-uuid> [flags]

Arguments

Argument Description
<cluster-uuid> Cluster UUID to create the queue in

Flags

Flag Description
-o, --output="" Output format. One of: json, yaml, text
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--description=STRING A description of the queue
--json Output as JSON
--key=STRING A unique key for the queue
--org=STRING Organization slug for this invocation (overrides environment and configuration)
--retry-agent-affinity=STRING Retry agent affinity setting (prefer-warmest or prefer-different)
--text Output as text
--yaml Output as YAML

Examples

Create a queue with just a key:

bk queue create my-cluster-uuid --key my-queue

Create a queue with a description:

bk queue create my-cluster-uuid --key my-queue --description "My new queue"

Create a queue with retry agent affinity set:

bk queue create my-cluster-uuid --key my-queue --retry-agent-affinity prefer-different

Create a queue and output as JSON:

bk queue create my-cluster-uuid --key my-queue -o json

Update a queue

Update a cluster queue.

At least one of --description or --retry-agent-affinity must be provided.

bk queue update <cluster-uuid> <queue-uuid> [flags]

Arguments

Argument Description
<cluster-uuid> Cluster UUID the queue belongs to
<queue-uuid> Queue UUID to update

Flags

Flag Description
-o, --output="" Output format. One of: json, yaml, text
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--description=STRING New description for the queue
--json Output as JSON
--org=STRING Organization slug for this invocation (overrides environment and configuration)
--retry-agent-affinity=STRING Retry agent affinity (prefer-warmest or prefer-different)
--text Output as text
--yaml Output as YAML

Examples

Update a queue's description:

bk queue update my-cluster-uuid my-queue-uuid --description "New description"

Update retry agent affinity:

bk queue update my-cluster-uuid my-queue-uuid --retry-agent-affinity prefer-different

Update both settings:

bk queue update my-cluster-uuid my-queue-uuid --description "New description" --retry-agent-affinity prefer-warmest

Output the updated queue as JSON:

bk queue update my-cluster-uuid my-queue-uuid --description "New description" -o json

Delete a queue

Delete a cluster queue.

You will be prompted to confirm deletion unless --yes is set.

bk queue delete <cluster-uuid> <queue-uuid>

Arguments

Argument Description
<cluster-uuid> Cluster UUID the queue belongs to
<queue-uuid> Queue UUID to delete

Flags

Flag Description
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--org=STRING Organization slug for this invocation (overrides environment and configuration)

Examples

Delete a queue:

bk queue delete my-cluster-uuid my-queue-uuid

Delete a queue without confirmation:

bk queue delete my-cluster-uuid my-queue-uuid --yes

Pause a queue

Pause dispatch for a cluster queue.

The queue remains paused until it is resumed with "bk queue resume".

bk queue pause <cluster-uuid> <queue-uuid> [flags]

Arguments

Argument Description
<cluster-uuid> Cluster UUID the queue belongs to
<queue-uuid> Queue UUID to pause

Flags

Flag Description
-o, --output="" Output format. One of: json, yaml, text
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--json Output as JSON
--note=STRING Optional note explaining why the queue is being paused
--org=STRING Organization slug for this invocation (overrides environment and configuration)
--text Output as text
--yaml Output as YAML

Examples

Pause a queue:

bk queue pause my-cluster-uuid my-queue-uuid

Pause a queue with a note:

bk queue pause my-cluster-uuid my-queue-uuid --note "Pausing for maintenance"

Output the paused queue as JSON:

bk queue pause my-cluster-uuid my-queue-uuid --note "Maintenance" -o json

Resume a queue

Resume dispatch for a cluster queue.

Resumes dispatch for a paused cluster queue.

bk queue resume <cluster-uuid> <queue-uuid> [flags]

Arguments

Argument Description
<cluster-uuid> Cluster UUID the queue belongs to
<queue-uuid> Queue UUID to resume

Flags

Flag Description
-o, --output="" Output format. One of: json, yaml, text
--debug Log HTTP API traffic to stderr; bodies may contain sensitive data
--json Output as JSON
--org=STRING Organization slug for this invocation (overrides environment and configuration)
--text Output as text
--yaml Output as YAML

Examples

Resume a queue:

bk queue resume my-cluster-uuid my-queue-uuid

Output the resumed queue as JSON:

bk queue resume my-cluster-uuid my-queue-uuid -o json