# dotCMS Site API

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

Site management, lifecycle, and configuration endpoints

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| PUT | `/api/v1/site/{siteId}/_archive` | Archive a site |
| PUT | `/api/v1/site/_copy` | Copy a site |
| GET | `/api/v1/site` | List sites with pagination |
| PUT | `/api/v1/site` | Update an existing site |
| POST | `/api/v1/site` | Create a new site |
| GET | `/api/v1/site/currentSite` | Get the current site for the logged-in user |
| GET | `/api/v1/site/defaultSite` | Get the default site |
| GET | `/api/v1/site/{siteId}` | Get a site by its identifier |
| DELETE | `/api/v1/site/{siteId}` | Delete a site |
| GET | `/api/v1/site/thumbnails` | Get thumbnails for all sites |
| POST | `/api/v1/site/_byname` | Find a site by name |
| GET | `/api/v1/site/{siteId}/setup_progress` | Get site setup progress |
| GET | `/api/v1/site/variable/{siteId}` | Retrieve the Site Variables for a site |
| PUT | `/api/v1/site/{siteId}/_makedefault` | Mark a site as the default |
| PUT | `/api/v1/site/{siteId}/_publish` | Publish a site |
| PUT | `/api/v1/site/variable` | Save a Site Variable |
| PUT | `/api/v1/site/switch` | Switch to the user's default site |
| PUT | `/api/v1/site/switch/{id}` | Switch to a specific site |
| PUT | `/api/v1/site/{siteId}/_unarchive` | Unarchive a site |
| PUT | `/api/v1/site/{siteId}/_unpublish` | Unpublish a site |

## Machine-readable artifacts (7)

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

Site

---

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