Settings

Show queue information

Show queue status and current state

get/v1/settings/queue/{queue}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/settings/queue/{queue}
  • Auth: HTTP bearer

Path parameters

queue'notify' | 'submit' required

Queue ID

Example:notify

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the job counts and paused state for the queue.

queue'notify' | 'submit' required

Queue ID

pausedboolean

Is the queue paused or not

Example response

{
  "queue": "notify",
  "jobs": {
    "active": 123,
    "delayed": 123,
    "waiting": 123
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.