APG PayAPG Paydocs

Operations

Update queue

PATCH/queues/{queueId}

Replay up to 100 of this queue's dead letters at once, each published again unchanged. Answers with the outcome for every id, Replayed, NotFound or Failed, and the queue as it reads afterwards. One that fails does not stop the rest.

Permissions

Required permission
queues:update

Requires the `update` action on `queues` for the supplied runtime context

Path parameters

queueIdstring
required

Request body

This body is a tagged shape: type is always "QueueUpdateReplayDeadLetters". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "QueueUpdateReplayDeadLetters"
queueDeadLetterIdsarray of string

The dead letters to replay, by queueDeadLetterId: 1 to 100 of them. An id named twice is replayed once.

curl -X PATCH https://api.tst.au.apgpay.dev/queues/{queueId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "QueueUpdateReplayDeadLetters",
  "queueDeadLetterIds": [
    "string"
  ]
}'

Responses

The response is a tagged shape: type is always "QueueDlqReplaysAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "QueueDlqReplaysAttributes"

The queue as it reads after the replay, so its backlog counts the messages put back.

Every distinct id named, with what became of it.

Example
{
  "type": "QueueDlqReplaysAttributes",
  "queue": {
    "type": "QueueAttributes",
    "queue": "string",
    "tickerLagSeconds": 1250,
    "eventsPerSecond": 12.5,
    "consumers": [
      {
        "type": "QueueConsumerAttributes",
        "consumer": "string",
        "backlog": 1250,
        "lagSeconds": 1250,
        "members": 1250,
        "silentMembers": 1250
      }
    ]
  },
  "results": [
    {
      "type": "QueueDlqReplayResultAttributes",
      "queueDeadLetterId": "string",
      "outcome": "Replayed",
      "error": "string"
    }
  ]
}

Error responses