queue.queues.redrive

Move a dead-letter queue’s messages back to their source queues

POST /queue/api/queues/{name}/redriveIAM queue:StartMessageMoveTaskChanges state

Without destination each message returns to the queue it was dead-lettered from; with one, all go there. Needs queue:SendMessage on every destination too. Messages arrive as new deliveries (receive count 0). In-flight messages, and ones whose source queue is gone, stay. Runs to completion and answers { taskId, moved, remaining }.

Request syntax

POST /queue/api/queues/{name}/redrive
{
  "destination": "string"
}

Path parameters

  • nameRequired

    string

    Constraints: max 80 chars, /^[A-Za-z0-9_-]+(\.fifo)?$/

Request body

  • destinationOptional

    string

    Queue to move every message to (default: each message goes back to the queue it was dead-lettered from)

    Constraints: max 80 chars, /^[A-Za-z0-9_-]+(\.fifo)?$/

Response

200 once the move has finished; data is the move task: taskId, status (COMPLETED or FAILED), moved and remaining (message counts), startedAt and finishedAt.

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:StartMessageMoveTask 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 redrive name

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_queue_queues_redrive.