queue.queues.set-attributesChange a queue’s attributes or its dead-letter queue
Only the fields sent change. deadLetterQueue: null removes the dead-letter queue.
Request syntax
PATCH /queue/api/queues/{name}
{
"visibilityTimeoutSeconds": "number",
"retentionSeconds": "number",
"delaySeconds": "number",
"receiveWaitSeconds": "number",
"maximumMessageBytes": "number",
"deadLetterQueue": "object",
"contentBasedDeduplication": "boolean"
}Path parameters
nameRequiredstring
Constraints: max 80 chars, /^[A-Za-z0-9_-]+(\.fifo)?$/
Request body
visibilityTimeoutSecondsOptionalnumber
Seconds a received message stays hidden from other consumers before it can be received again; 30 for a new queue
Constraints: integer, 0-43200
retentionSecondsOptionalnumber
Seconds a message is kept before it is deleted unreceived; applies to messages sent afterwards; 4 days for a new queue
Constraints: integer, 60-1209600
delaySecondsOptionalnumber
Seconds a newly sent message stays invisible before it can be received; 0 for a new queue
Constraints: integer, 0-900
receiveWaitSecondsOptionalnumber
Seconds a receive waits for a message when it names no wait of its own; 0 answers at once; 0 for a new queue
Constraints: integer, 0-20
maximumMessageBytesOptionalnumber
Largest message the queue accepts, in bytes, counting the body and attributes; 256 KiB for a new queue
Constraints: integer, 1024-262144
deadLetterQueueOptionalobject
Another queue of the organization (name) that receives a message after it has been received maxReceiveCount times without being deleted; null removes it; none for a new queue
Constraints: JSON
May be null.
contentBasedDeduplicationOptionalboolean
FIFO queues only: a send without messageDeduplicationId is deduplicated by the SHA-256 of its body; false for a new queue
Response
200; data is the updated queue: id, name, region, fifo, its attributes (visibilityTimeoutSeconds, retentionSeconds, delaySeconds, receiveWaitSeconds, maximumMessageBytes, contentBasedDeduplication), deadLetterQueue ({ name, maxReceiveCount } or null), messages (counts: available, inFlight, delayed, deadLettered, total, and bytes), createdAt and updatedAt.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow queue:SetQueueAttributes on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud queue queues set-attributes namecurl -X PATCH "https://console.platform-development.deutschecloud.app/queue/api/queues/name" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_queue_queues_set-attributes.