queue.queues.purgeDelete every message in a queue, keeping the queue
POST /queue/api/queues/{name}/purgeIAM queue:PurgeQueueChanges stateDestructive
Request syntax
POST /queue/api/queues/{name}/purgePath parameters
nameRequiredstring
Constraints: max 80 chars, /^[A-Za-z0-9_-]+(\.fifo)?$/
Response
200; data.deleted is the number of messages deleted.
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:PurgeQueue 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 purge namecurl -X POST "https://console.platform-development.deutschecloud.app/queue/api/queues/name/purge" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY"Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_queue_queues_purge.