API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Queues

List Queues

client.Queues.List(ctx, query) (*SinglePage[Queue], error)

GET/accounts/{account_id}/queues

Get Queue

client.Queues.Get(ctx, queueID, query) (*Queue, error)

GET/accounts/{account_id}/queues/{queue_id}

Create Queue

client.Queues.New(ctx, params) (*Queue, error)

POST/accounts/{account_id}/queues

Update Queue

client.Queues.Update(ctx, queueID, params) (*Queue, error)

PUT/accounts/{account_id}/queues/{queue_id}

Update Queue

client.Queues.Edit(ctx, queueID, params) (*Queue, error)

PATCH/accounts/{account_id}/queues/{queue_id}

Delete Queue

client.Queues.Delete(ctx, queueID, body) (*QueueDeleteResponse, error)

DELETE/accounts/{account_id}/queues/{queue_id}

ModelsExpand Collapse

type Queue struct{…}

Consumers []Consumeroptional

One of the following:

type ConsumerMqWorkerConsumerResponse struct{…}

ConsumerID stringoptional

A Resource identifier.

maxLength32

CreatedOn Timeoptional

formatdate-time

DeadLetterQueue stringoptional

Name of the dead letter queue, or empty string if not configured

QueueName stringoptional

ScriptName stringoptional

Name of a Worker

Settings ConsumerMqWorkerConsumerResponseSettingsoptional

BatchSize float64optional

The maximum number of messages to include in a batch.

MaxConcurrency float64optional

Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).

MaxRetries float64optional

The maximum number of retries

MaxWaitTimeMs float64optional

The number of milliseconds to wait for a batch to fill up before attempting to deliver it

RetryDelay float64optional

The number of seconds to delay before making the message available for another attempt.

Type ConsumerMqWorkerConsumerResponseTypeoptional

type ConsumerMqHTTPConsumerResponse struct{…}

ConsumerID stringoptional

A Resource identifier.

maxLength32

CreatedOn Timeoptional

formatdate-time

DeadLetterQueue stringoptional

Name of the dead letter queue, or empty string if not configured

QueueName stringoptional

Settings ConsumerMqHTTPConsumerResponseSettingsoptional

BatchSize float64optional

The maximum number of messages to include in a batch.

MaxRetries float64optional

The maximum number of retries

RetryDelay float64optional

The number of seconds to delay before making the message available for another attempt.

VisibilityTimeoutMs float64optional

The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.

Type ConsumerMqHTTPConsumerResponseTypeoptional

ConsumersTotalCount float64optional

CreatedOn stringoptional

ModifiedOn stringoptional

Producers []QueueProduceroptional

One of the following:

type QueueProducersMqWorkerProducer struct{…}

Script stringoptional

Type QueueProducersMqWorkerProducerTypeoptional

type QueueProducersMqR2Producer struct{…}

BucketName stringoptional

Type QueueProducersMqR2ProducerTypeoptional

ProducersTotalCount float64optional

QueueID stringoptional

QueueName stringoptional

Settings QueueSettingsoptional

DeliveryDelay float64optional

Number of seconds to delay delivery of all messages to consumers.

DeliveryPaused booloptional

Indicates if message delivery to consumers is currently paused.

MessageRetentionPeriod float64optional

Number of seconds after which an unconsumed message will be delayed.

QueuesMessages

Push Message

client.Queues.Messages.Push(ctx, queueID, params) (*MessagePushResponse, error)

POST/accounts/{account_id}/queues/{queue_id}/messages

Acknowledge + Retry Queue Messages

client.Queues.Messages.Ack(ctx, queueID, params) (*MessageAckResponse, error)

POST/accounts/{account_id}/queues/{queue_id}/messages/ack

Pull Queue Messages

client.Queues.Messages.Pull(ctx, queueID, params) (*MessagePullResponse, error)

POST/accounts/{account_id}/queues/{queue_id}/messages/pull

Push Message Batch

client.Queues.Messages.BulkPush(ctx, queueID, params) (*MessageBulkPushResponse, error)

POST/accounts/{account_id}/queues/{queue_id}/messages/batch

QueuesPurge

Get Queue Purge Status

client.Queues.Purge.Status(ctx, queueID, query) (*PurgeStatusResponse, error)

GET/accounts/{account_id}/queues/{queue_id}/purge

Purge Queue

client.Queues.Purge.Start(ctx, queueID, params) (*Queue, error)

POST/accounts/{account_id}/queues/{queue_id}/purge

QueuesConsumers

List Queue Consumers

client.Queues.Consumers.List(ctx, queueID, query) (*SinglePage[Consumer], error)

GET/accounts/{account_id}/queues/{queue_id}/consumers

Get Queue Consumer

client.Queues.Consumers.Get(ctx, queueID, consumerID, query) (*Consumer, error)

GET/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Create a Queue Consumer

client.Queues.Consumers.New(ctx, queueID, params) (*Consumer, error)

POST/accounts/{account_id}/queues/{queue_id}/consumers

Update Queue Consumer

client.Queues.Consumers.Update(ctx, queueID, consumerID, params) (*Consumer, error)

PUT/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

Delete Queue Consumer

client.Queues.Consumers.Delete(ctx, queueID, consumerID, body) (*ConsumerDeleteResponse, error)

DELETE/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}

ModelsExpand Collapse

type Consumer interface{…}

Response body representing a consumer

One of the following:

type ConsumerMqWorkerConsumerResponse struct{…}

ConsumerID stringoptional

A Resource identifier.

maxLength32

CreatedOn Timeoptional

formatdate-time

DeadLetterQueue stringoptional

Name of the dead letter queue, or empty string if not configured

QueueName stringoptional

ScriptName stringoptional

Name of a Worker

Settings ConsumerMqWorkerConsumerResponseSettingsoptional

BatchSize float64optional

The maximum number of messages to include in a batch.

MaxConcurrency float64optional

Maximum number of concurrent consumers that may consume from this Queue. Set to null to automatically opt in to the platform's maximum (recommended).

MaxRetries float64optional

The maximum number of retries

MaxWaitTimeMs float64optional

The number of milliseconds to wait for a batch to fill up before attempting to deliver it

RetryDelay float64optional

The number of seconds to delay before making the message available for another attempt.

Type ConsumerMqWorkerConsumerResponseTypeoptional

type ConsumerMqHTTPConsumerResponse struct{…}

ConsumerID stringoptional

A Resource identifier.

maxLength32

CreatedOn Timeoptional

formatdate-time

DeadLetterQueue stringoptional

Name of the dead letter queue, or empty string if not configured

QueueName stringoptional

Settings ConsumerMqHTTPConsumerResponseSettingsoptional

BatchSize float64optional

The maximum number of messages to include in a batch.

MaxRetries float64optional

The maximum number of retries

RetryDelay float64optional

The number of seconds to delay before making the message available for another attempt.

VisibilityTimeoutMs float64optional

The number of milliseconds that a message is exclusively leased. After the timeout, the message becomes available for another attempt.

Type ConsumerMqHTTPConsumerResponseTypeoptional

QueuesSubscriptions

List Event Subscriptions

client.Queues.Subscriptions.List(ctx, params) (*V4PagePaginationArray[SubscriptionListResponse], error)

GET/accounts/{account_id}/event_subscriptions/subscriptions

Get Event Subscription

client.Queues.Subscriptions.Get(ctx, subscriptionID, query) (*SubscriptionGetResponse, error)

GET/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}

Create Event Subscription

client.Queues.Subscriptions.New(ctx, params) (*SubscriptionNewResponse, error)

POST/accounts/{account_id}/event_subscriptions/subscriptions

Update Event Subscription

client.Queues.Subscriptions.Update(ctx, subscriptionID, params) (*SubscriptionUpdateResponse, error)

PATCH/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}

Delete Event Subscription

client.Queues.Subscriptions.Delete(ctx, subscriptionID, body) (*SubscriptionDeleteResponse, error)

DELETE/accounts/{account_id}/event_subscriptions/subscriptions/{subscription_id}