Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Generated Assets

Assets

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

get
list
create
update
delete
send
lease
ack
nack
replay

Reference

sylphx events queues

Every sylphx events queues command: its argument, its flags and a run line.

Checked 2026-09-28

The queues commands of Sylphx Events, as the CLI spells them: the same calls as the queues API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#get

Gets a queue.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events queues get orgs/acme/projects/shop/envs/production/queues/queue

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue · scope events:read · effect read · Request, response and examples

#list

Lists queues.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell

sylphx events queues list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues · scope events:read · effect read · Request, response and examples

Flags

Flag	Type	What it does
`--page-size`	`int`	At most this many; default 50, clamped to 1000.
`--page-token`	`string`	`next_page_token` of the previous page.
`--filter`	`string`	AIP-160 filter over labels and filterable fields.
`--order-by`	`string`	AIP-132 ordering over filterable fields.

#create

Creates a queue.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell

sylphx events queues create --parent orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--parent`	`string`	The parent to create in; defaults to the linked project or the key's scope.
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--spec.visibility-timeout`	`duration`	How long a lease hides a message; default 30s, 1s to 12h.
`--spec.max-deliveries`	`int`	Deliveries before a message dead-letters; default 5, 1 to 100.
`--spec.dead-letter-queue`	`string`	The dead-letter Queue; unset keeps exhausted messages in this Queue's own dead-letter set.
`--spec.retention`	`duration`	How long an unacked message is kept; default 4d, at most 14d.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#update

Updates a queue.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events queues update orgs/acme/projects/shop/envs/production/queues/queue

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--spec.visibility-timeout`	`duration`	How long a lease hides a message; default 30s, 1s to 12h.
`--spec.max-deliveries`	`int`	Deliveries before a message dead-letters; default 5, 1 to 100.
`--spec.dead-letter-queue`	`string`	The dead-letter Queue; unset keeps exhausted messages in this Queue's own dead-letter set.
`--spec.retention`	`duration`	How long an unacked message is kept; default 4d, at most 14d.
`--allow-missing`	`bool`	Create the queue when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#delete

Deletes a queue.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events queues delete orgs/acme/projects/shop/envs/production/queues/queue --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue · scope events:write · effect destructive · Request, response and examples

Flags

Flag	Type	What it does
`--etag`	`string`	Delete only if the current etag matches.
`--allow-missing`	`bool`	Succeed when the queue does not exist.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--yes`	`bool`	Do not ask before this destructive call.

#send

Enqueues messages directly, without a Subscription.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events queues send orgs/acme/projects/shop/envs/production/queues/queue

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:send · scope events:publish · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--events`	`json`	The messages, at most 100. Required. Repeat the flag for each value.
`--delay`	`duration`	Hide the messages this long before their first lease.

#lease

Leases up to max_messages ready messages for the visibility timeout.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events queues lease orgs/acme/projects/shop/envs/production/queues/queue

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:lease · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--max-messages`	`int`	At most this many; default 1, at most 100.
`--visibility-timeout`	`duration`	Override the Queue's visibility timeout for this lease.
`--wait`	`duration`	Wait up to this long (at most 20s) for a message when none is ready.

#ack

Acknowledges leased messages; each is removed. A lease that is stale (expired or superseded) is reported, not applied.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events queues ack orgs/acme/projects/shop/envs/production/queues/queue

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:ack · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--leases`	`json`	The leases to ack, at most 100. Required. Repeat the flag for each value.

#nack

Returns leased messages to the Queue after delay; each nack counts as a delivery.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events queues nack orgs/acme/projects/shop/envs/production/queues/queue

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:nack · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--leases`	`json`	The leases to nack, at most 100. Required. Repeat the flag for each value.
`--delay`	`duration`	Hide the messages this long before the next lease.

#replay

Moves dead-lettered messages, optionally bounded by dead-letter time, back to ready.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events queues replay orgs/acme/projects/shop/envs/production/queues/queue

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:replay · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--start-time`	`timestamp`	Replay messages dead-lettered at or after this time.
`--end-time`	`timestamp`	Replay messages dead-lettered before this time.

Was this page helpful?

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

Send feedback

Platform links