Queues API

Base URL: https://YOUR-SERVER/api. Send your API key in x-api-key where authentication is required. A key also needs the listed permission; your account's access rules still apply.

API guide · All endpoints · OpenAPI JSON

• GET /queues — List all queues
• GET /queues/{name} — Retrieve a queue
• PUT /queues/{name} — Update a queue
• DELETE /queues/{name}/jobs — Empty a queue
• POST /queues/{name}/jobs/retry-failed — Retry failed queue jobs
• GET /queues/{name}/statistics — Retrieve queue statistics for an account

List all queues

GET /api/queues

Retrieves a list of queues.

Administrator access required.

Authentication: API key. Permission: queue.read.

Responses

Field definitions: QueueResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "items": {
            "$ref": "#/components/schemas/QueueResponseDto"
          },
          "type": "array"
        }
      }
    },
    "description": ""
  }
}

Retrieve a queue

GET /api/queues/{name}

Retrieves a specific queue by its name.

Administrator access required.

Authentication: API key. Permission: queue.read.

Parameters

Name	Where	Required	Description
name	path	Yes

Parameter types, defaults and constraints

Field definitions: QueueName

[
  {
    "name": "name",
    "required": true,
    "in": "path",
    "schema": {
      "$ref": "#/components/schemas/QueueName"
    }
  }
]

Responses

Field definitions: QueueResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/QueueResponseDto"
        }
      }
    },
    "description": ""
  }
}

Update a queue

PUT /api/queues/{name}

Change the paused status of a specific queue.

Administrator access required.

Authentication: API key. Permission: queue.update.

Parameters

Name	Where	Required	Description
name	path	Yes

Parameter types, defaults and constraints

Field definitions: QueueName

[
  {
    "name": "name",
    "required": true,
    "in": "path",
    "schema": {
      "$ref": "#/components/schemas/QueueName"
    }
  }
]

Request body

Required.

Field definitions: QueueUpdateDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/QueueUpdateDto"
    }
  }
}

Responses

Field definitions: QueueResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/QueueResponseDto"
        }
      }
    },
    "description": ""
  }
}

Empty a queue

DELETE /api/queues/{name}/jobs

Removes all jobs from the specified queue.

Administrator access required.

Authentication: API key. Permission: queueJob.delete.

Parameters

Name	Where	Required	Description
name	path	Yes

Parameter types, defaults and constraints

Field definitions: QueueName

[
  {
    "name": "name",
    "required": true,
    "in": "path",
    "schema": {
      "$ref": "#/components/schemas/QueueName"
    }
  }
]

Request body

Required.

Field definitions: QueueDeleteDto

{
  "application/json": {
    "schema": {
      "$ref": "#/components/schemas/QueueDeleteDto"
    }
  }
}

Responses

{
  "204": {
    "description": ""
  }
}

Retry failed queue jobs

POST /api/queues/{name}/jobs/retry-failed

Puts every failed job of the specified queue back in the queue with its saved data.

Administrator access required.

Authentication: API key. Permission: queueJob.create.

Parameters

Name	Where	Required	Description
name	path	Yes

Parameter types, defaults and constraints

Field definitions: QueueName

[
  {
    "name": "name",
    "required": true,
    "in": "path",
    "schema": {
      "$ref": "#/components/schemas/QueueName"
    }
  }
]

Responses

Field definitions: QueueRetryFailedResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/QueueRetryFailedResponseDto"
        }
      }
    },
    "description": ""
  }
}

Retrieve queue statistics for an account

GET /api/queues/{name}/statistics

Counts, per state, the jobs of the specified queue that work on one account's items. At most 1,000 jobs of each state are read; `truncated` marks lower bounds.

Administrator access required.

Authentication: API key. Permission: queueJob.read.

Parameters

Name	Where	Required	Description
name	path	Yes
ownerId	query	Yes	The account whose jobs are counted

Parameter types, defaults and constraints

Field definitions: QueueName

[
  {
    "name": "name",
    "required": true,
    "in": "path",
    "schema": {
      "$ref": "#/components/schemas/QueueName"
    }
  },
  {
    "name": "ownerId",
    "required": true,
    "in": "query",
    "description": "The account whose jobs are counted",
    "schema": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    }
  }
]

Responses

Field definitions: QueueOwnerStatisticsResponseDto

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/QueueOwnerStatisticsResponseDto"
        }
      }
    },
    "description": ""
  }
}