Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
Queue
ResourceMeta
QueueSpec
Response
ResourceMeta
QueueSpec
QueueStatus
Condition
Errors
Examples

Reference

Create a queue

Creates a queue.

Checked 2026-09-28

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

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

Field	Type	What it is
`parent`	`string`	The parent to create in. Required.
`queue_id`	`string`	The queue id, the final name segment; the server assigns one when empty.
`queue`	`Queue`	The queue to create; only caller-writable fields are read. Required.
`validate_only`	`bool`	Validate and return the result without writing anything.

#Queue

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/queues/{queue}`.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`QueueSpec`	Desired state. Required.

#ResourceMeta

Field	Type	What it is
`labels`	`map<string, string>`	Caller-writable, indexed labels (AIP-122 label rules).
`annotations`	`map<string, string>`	Caller-writable, unindexed annotations.
`display_name`	`string`	Caller-writable human-readable name.

#QueueSpec

Field	Type	What it is
`visibility_timeout`	`duration`	How long a lease hides a message; default 30s, 1s to 12h.
`max_deliveries`	`int32`	Deliveries before a message dead-letters; default 5, 1 to 100.
`dead_letter_queue`	`string`	The dead-letter Queue; unset keeps exhausted messages in this Queue's own dead-letter set.
`retention`	`duration`	How long an unacked message is kept; default 4d, at most 14d.

#Response

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/queues/{queue}`.
`uid`	`string`	`que_<cell><ulid>`; never reused. Output only.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`QueueSpec`	Desired state. Required.
`status`	`QueueStatus`	Observed state. Output only.

#ResourceMeta

Field	Type	What it is
`generation`	`int64`	Increases by one on every change to `spec`. Output only.
`etag`	`string`	Strong 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_time`	`timestamp`	When the Resource was created. Output only.
`update_time`	`timestamp`	When the Resource last changed. Output only.
`delete_time`	`timestamp`	Set while the Resource is being deleted. Output only.
`labels`	`map<string, string>`	Caller-writable, indexed labels (AIP-122 label rules).
`annotations`	`map<string, string>`	Caller-writable, unindexed annotations.
`display_name`	`string`	Caller-writable human-readable name.
`creator`	`string`	The principal that created the Resource. Output only.

#QueueSpec

Field	Type	What it is
`visibility_timeout`	`duration`	How long a lease hides a message; default 30s, 1s to 12h.
`max_deliveries`	`int32`	Deliveries before a message dead-letters; default 5, 1 to 100.
`dead_letter_queue`	`string`	The dead-letter Queue; unset keeps exhausted messages in this Queue's own dead-letter set.
`retention`	`duration`	How long an unacked message is kept; default 4d, at most 14d.

#QueueStatus

Field	Type	What it is
`observed_generation`	`int64`	The generation this status was computed from. Output only.
`conditions`	`Condition[]`	Ready, Reconciling, Stalled. Output only.
`ready_count`	`int64`	Messages ready to lease. Output only.
`leased_count`	`int64`	Messages under lease. Output only.
`dead_letter_count`	`int64`	Messages in the dead-letter set. Output only.

#Condition

Field	Type	What it is
`type`	`string`	The condition type, for example `Ready`.
`status`	`ConditionStatus`	Whether the condition holds. One of `true`, `false`, `unknown`.
`observed_generation`	`int64`	The generation this observation was made against.
`reason`	`string`	A machine-readable UpperCamelCase reason.
`message`	`string`	A customer-safe human-readable message.
`severity`	`Severity`	How severe a FALSE condition is. One of `info`, `warning`, `error`.
`transition_time`	`timestamp`	When `status` last changed.

#Errors

UNAUTHENTICATED — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
RESOURCE_ALREADY_EXISTS — A Resource with this name exists.
IDEMPOTENCY_KEY_REUSED — An Idempotency-Key was reused with another body.
IDEMPOTENCY_IN_PROGRESS — The first call with this Idempotency-Key is still running.
PLAN_LIMIT_REACHED — The plan's limit is reached.

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":{}}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links