Sign in

v1

latestOpenAPI 3.0.12026-07-142257126.4 KB
queues

Creates a queue

Creates a queue for the application specified by application ID. The properties for the queue to be created are specified in the request body.

post/apps/{app_id}/queues

Path parameters

app_idstring required

The application ID.

Request body

maxLengthinteger required

Message limit in number of messages.

namestring required

A friendly name for your queue.

regionstring required

The data center region. US East (Virginia) or EU West (Ireland). Values are us-east-1-a or eu-west-1-a.

ttlinteger required

TTL in minutes.

Example request

{
  "maxLength": 10000,
  "name": "My queue",
  "region": "us-east-1-a",
  "ttl": 60
}

Response

Queue created

appIdstring

The Ably application ID.

deadletterboolean

A boolean that indicates whether this is a dead letter queue or not.

deadletterIdstring nullable
idstring

The ID of the Ably queue

maxLengthinteger

Message limit in number of messages.

namestring

The friendly name of the queue.

regionstring

The data center region for the queue.

statestring

The current state of the queue.

ttlinteger

TTL in minutes.

Example response

{
  "amqp": {
    "queueName": "28AB6w:My queue",
    "uri": "amqps://us-east-1-a-queue.ably.io:5671/shared"
  },
  "appId": "28AB6w",
  "deadletterId": "28AB6w:us-east-1-a:deadletter",
  "id": "28AB6w:us-east-1-a:My queue",
  "maxLength": 10000,
  "name": "My queue",
  "region": "eu-west-1-a",
  "state": "Running",
  "stomp": {
    "destination": "/amqp/queue/28AB6w:My queue",
    "host": "shared",
    "uri": "stomp://us-east-1-a-queue.ably.io:61614"
  },
  "ttl": 60
}