Queues

Queues

Methods

list(, ): <>
get/accounts/{account_id}/queues

Returns the queues owned by an account.

get(, , ):
get/accounts/{account_id}/queues/{queue_id}

Get details about a specific queue.

create(, ):
post/accounts/{account_id}/queues

Create a new queue

update(, , ):
put/accounts/{account_id}/queues/{queue_id}

Updates a Queue. Note that this endpoint does not support partial updates. If successful, the Queue's configuration is overwritten with the supplied configuration.

edit(, , ):
patch/accounts/{account_id}/queues/{queue_id}

Updates a Queue.

delete(, , ):
delete/accounts/{account_id}/queues/{queue_id}

Deletes a queue

Domain types

Queue{…}
Queues

Consumers

Queues.Consumers

Methods

list(, , ): <>
get/accounts/{account_id}/queues/{queue_id}/consumers

Returns the consumers for a Queue

get(, , , ):
get/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Fetches the consumer for a queue by consumer id

create(, , ):
post/accounts/{account_id}/queues/{queue_id}/consumers

Creates a new consumer for a Queue

update(, , , ):
put/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Updates the consumer for a queue, or creates one if it does not exist.

delete(, , , ):
delete/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Deletes the consumer for a queue.

Queues

Messages

Queues.Messages

Methods

push(, , ):
post/accounts/{account_id}/queues/{queue_id}/messages

Push a message to a Queue

ack(, , ):
post/accounts/{account_id}/queues/{queue_id}/messages/ack

Acknowledge + Retry messages from a Queue

pull(, , ):
post/accounts/{account_id}/queues/{queue_id}/messages/pull

Pull a batch of messages from a Queue

bulkPush(, , ):
post/accounts/{account_id}/queues/{queue_id}/messages/batch

Push a batch of message to a Queue

Queues

Purge

Queues.Purge

Methods

status(, , ):
get/accounts/{account_id}/queues/{queue_id}/purge

Get details about a Queue's purge status.

start(, , ):
post/accounts/{account_id}/queues/{queue_id}/purge

Deletes all messages from the Queue.

Queues

Subscriptions

Queues.Subscriptions

Methods

list(, ): <>
get/accounts/{account_id}/event_subscriptions/subscriptions

Get a paginated list of event subscriptions with optional sorting and filtering

get(, , ):
get/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}

Get details about an existing event subscription

create(, ):
post/accounts/{account_id}/event_subscriptions/subscriptions

Create a new event subscription for a queue

update(, , ):
patch/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}

Update an existing event subscription

delete(, , ):
delete/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}

Delete an existing event subscription