# dotCMS Job Queue API

**Canonical:** https://apis.io/apis/dotcms/dotcms-job-queue-api/  
**Provider:** dotCMS — https://apis.io/providers/dotcms/  
**Base URL:** https://demo.dotcms.com/api  
**Documentation:** https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis

dotCMS Job Queue API is one of 73 APIs that [dotCMS](https://apis.io/providers/dotcms/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Job Queue. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Endpoints for managing background jobs and job queues

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/jobs/abandoned` | Retrieves abandoned jobs |
| GET | `/api/v1/jobs/active` | Retrieves active jobs |
| GET | `/api/v1/jobs/{queueName}/active` | Retrieves active jobs in a queue |
| POST | `/api/v1/jobs/{jobId}/cancel` | Cancel a job |
| GET | `/api/v1/jobs/canceled` | Retrieves canceled jobs |
| GET | `/api/v1/jobs/completed` | Retrieves completed jobs |
| POST | `/api/v1/jobs/{queueName}/upload` | Creates a new job with form data |
| POST | `/api/v1/jobs/{queueName}` | Creates a new job with JSON parameters |
| GET | `/api/v1/jobs/failed` | Retrieves failed jobs |
| GET | `/api/v1/jobs/{jobId}/status` | Retrieves job status information |
| GET | `/api/v1/jobs/queues` | Retrieves available job queues |
| GET | `/api/v1/jobs` | Retrieves jobs |
| GET | `/api/v1/jobs/{jobId}/monitor` | Monitor a job in real time |
| GET | `/api/v1/jobs/successful` | Retrieves successful jobs |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/openapi/dotcms-job-queue-api-openapi.yml
- **Documentation** — https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis
- **DeveloperPortal** — https://dev.dotcms.com/
- **APIReference** — https://dev.dotcms.com/docs/build/apis/rest-apis/api-playground
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/errors/dotcms-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/data-model/dotcms-data-model.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/conventions/dotcms-conventions.yml

## Other dotCMS APIs (12)

- [dotCMS GraphQL API](https://apis.io/apis/dotcms/graphql/)
- [dotCMS Accessibility Agent API](https://apis.io/apis/dotcms/dotcms-accessibility-agent-api/)
- [dotCMS Accessibility Checker API](https://apis.io/apis/dotcms/dotcms-accessibility-checker-api/)
- [dotCMS Administration API](https://apis.io/apis/dotcms/dotcms-administration-api/)
- [dotCMS AI API](https://apis.io/apis/dotcms/dotcms-ai-api/)
- [dotCMS Announcements API](https://apis.io/apis/dotcms/dotcms-announcements-api/)
- [dotCMS API Token API](https://apis.io/apis/dotcms/dotcms-api-token-api/)
- [dotCMS Apps API](https://apis.io/apis/dotcms/dotcms-apps-api/)
- [dotCMS Authentication API](https://apis.io/apis/dotcms/dotcms-authentication-api/)
- [dotCMS Browser Tree API](https://apis.io/apis/dotcms/dotcms-browser-tree-api/)
- [dotCMS Bundle API](https://apis.io/apis/dotcms/dotcms-bundle-api/)
- [dotCMS Cache Management API](https://apis.io/apis/dotcms/dotcms-cache-management-api/)

## Tags

Job Queue

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/dotcms/dotcms-job-queue-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/dotcms/.