/queue

GET

/queue

const url = 'https://example.com/api/v1/queue?queue=incoming&limit=50&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/queue?queue=incoming&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

The Postfix queue as postqueue -j reports it now, oldest first, with per-queue counts. domain_admin sees only messages whose sender or a recipient is one of its domains. An unreachable queue agent answers reachable: false with an empty list rather than an error, so the screen can say what is wrong.

Authorizations

bearer

Parameters

Query Parameters

queue

string

Allowed values: incoming active deferred hold corrupt maildrop

string

<= 200 characters

limit

integer

default: 50 >= 1 <= 200

offset

integer

0 <= 9007199254740991

Responses

200

Default Response

application/json

object

items

required

Array<object>

object

queueId

required

string

>= 1 characters <= 40 characters /^[0-9A-Za-z]+$/

queue

required

string

Allowed values: incoming active deferred hold corrupt maildrop

arrivedAt

required

string

sizeBytes

required

integer

<= 9007199254740991

sender

required

string

recipients

required

Array<object>

object

address

required

string

delayReason

required

Any of:

string
null

string

lastError

required

Any of:

string
null

string

forcedExpire

required

boolean

total

required

integer

>= -9007199254740991 <= 9007199254740991

byQueue

required

object

key

additional properties

integer

>= -9007199254740991 <= 9007199254740991

queueTotal

required

integer

>= -9007199254740991 <= 9007199254740991

truncated

required

boolean

takenAt

required

string

reachable

required

boolean

detail

required

string

Example

{
  "items": [
    {
      "queue": "incoming"
    }
  ]
}