Skip to content
Console
On this page

Create a queue

Creates a queue.

Creates a queue.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues
  • Scope events:write
  • Effect write — a successful call changes state.
  • Collection queues
  • Query queue_id, validate_only

Request

FieldTypeWhat it is
parentstringThe parent to create in. Required.
queue_idstringThe queue id, the final name segment; the server assigns one when empty.
queueQueueThe queue to create; only caller-writable fields are read. Required.
validate_onlyboolValidate and return the result without writing anything.

Queue

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/queues/{queue}.
metaResourceMetaResource metadata.
specQueueSpecDesired state. Required.

ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

QueueSpec

FieldTypeWhat it is
visibility_timeoutdurationHow long a lease hides a message; default 30s, 1s to 12h.
max_deliveriesint32Deliveries before a message dead-letters; default 5, 1 to 100.
dead_letter_queuestringThe dead-letter Queue; unset keeps exhausted messages in this Queue's own dead-letter set.
retentiondurationHow long an unacked message is kept; default 4d, at most 14d.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/queues/{queue}.
uidstringque_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specQueueSpecDesired state. Required.
statusQueueStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

QueueSpec

FieldTypeWhat it is
visibility_timeoutdurationHow long a lease hides a message; default 30s, 1s to 12h.
max_deliveriesint32Deliveries before a message dead-letters; default 5, 1 to 100.
dead_letter_queuestringThe dead-letter Queue; unset keeps exhausted messages in this Queue's own dead-letter set.
retentiondurationHow long an unacked message is kept; default 4d, at most 14d.

QueueStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
ready_countint64Messages ready to lease. Output only.
leased_countint64Messages under lease. Output only.
dead_letter_countint64Messages in the dead-letter set. Output only.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{}}'