# dotCMS Containers API

**Canonical:** https://apis.io/apis/dotcms/dotcms-containers-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 Containers 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 Containers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

Endpoints for managing Container objects and their content

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| PUT | `/api/v1/containers/_archive` | Archives a container |
| PUT | `/api/v1/containers/_bulkarchive` | Archives multiple containers |
| DELETE | `/api/v1/containers/_bulkdelete` | Deletes multiple containers |
| PUT | `/api/v1/containers/_bulkpublish` | Publishes multiple containers |
| PUT | `/api/v1/containers/_bulkunarchive` | Unarchives multiple containers |
| PUT | `/api/v1/containers/_bulkunpublish` | Unpublishes multiple containers |
| GET | `/api/v1/containers/{containerId}/content/{contentletId}` | Renders content HTML within a container |
| GET | `/api/v1/containers/content/{contentletId}` | Renders content HTML with container ID as query param |
| GET | `/api/v1/containers/{containerId}/form/{formId}` | Renders a form within a container |
| GET | `/api/v1/containers/form/{formId}` | Renders a form with container ID as query param |
| POST | `/api/v1/containers/{id}/_copy` | Copies a container to the current host |
| GET | `/api/v1/containers` | Retrieves a paginated list of Containers |
| PUT | `/api/v1/containers` | Updates an existing container |
| POST | `/api/v1/containers` | Creates a new container |
| DELETE | `/api/v1/containers` | Deletes a container |
| GET | `/api/v1/containers/live` | Retrieves a live container by ID |
| GET | `/api/v1/containers/working` | Retrieves a working container by ID |
| PUT | `/api/v1/containers/_publish` | Publishes a container |
| DELETE | `/api/v1/containers/delete/{containerId}/content/{contentletId}/uid/{uid}` | Removes content from a container |
| PUT | `/api/v1/containers/_unarchive` | Unarchives a container |
| PUT | `/api/v1/containers/_unpublish` | Unpublishes a container |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/openapi/dotcms-containers-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

Containers

---

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