# Confluence Cloud REST API v1

**Canonical:** https://apis.io/apis/confluence/confluence-cloud-rest-api-v1/  
**Provider:** Confluence — https://apis.io/providers/confluence/  
**Base URL:** https://your-domain.atlassian.net  
**Documentation:** https://developer.atlassian.com/cloud/confluence/rest/v1/intro/

Confluence Cloud REST API v1 is one of 70 APIs that [Confluence](https://apis.io/providers/confluence/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Search, Content, User, Group, and Audit. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and a getting-started guide.

The legacy Confluence Cloud REST surface under /wiki/rest/api. 130 operations, still the only place several capabilities are published — CQL search, audit records, groups and users, content restrictions, templates and blueprints, themes and look-and-feel, relations, watchers, long-running tasks and attachment upload.

## Operations (60 of 130)

| Method | Path | Summary |
|---|---|---|
| GET | `/wiki/rest/api/audit` | Get audit records |
| POST | `/wiki/rest/api/audit` | Create audit record |
| GET | `/wiki/rest/api/audit/export` | Export audit records |
| GET | `/wiki/rest/api/audit/retention` | Get retention period |
| PUT | `/wiki/rest/api/audit/retention` | Set retention period |
| GET | `/wiki/rest/api/audit/since` | Get audit records for time period |
| POST | `/wiki/rest/api/content/archive` | Archive pages |
| PUT | `/wiki/rest/api/content/blueprint/instance/{draftId}` | Publish shared draft |
| POST | `/wiki/rest/api/content/blueprint/instance/{draftId}` | Publish legacy draft |
| GET | `/wiki/rest/api/content/search` | Search content by CQL |
| DELETE | `/wiki/rest/api/content/{id}/pageTree` | Delete page tree |
| PUT | `/wiki/rest/api/content/{pageId}/move/{position}/{targetId}` | Move a page to a new location relative to a target page |
| PUT | `/wiki/rest/api/content/{id}/child/attachment` | Create or update attachment |
| POST | `/wiki/rest/api/content/{id}/child/attachment` | Create attachment |
| PUT | `/wiki/rest/api/content/{id}/child/attachment/{attachmentId}` | Update attachment properties |
| POST | `/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data` | Update attachment data |
| GET | `/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download` | Get URI to download attachment |
| GET | `/wiki/rest/api/content/{id}/descendant` | Get content descendants |
| GET | `/wiki/rest/api/content/{id}/descendant/{type}` | Get content descendants by type |
| GET | `/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}` | Get macro body by macro ID |
| GET | `/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to}` | Get macro body by macro ID and convert the representation synchronously |
| GET | `/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to}` | Get macro body by macro ID and convert representation Asynchronously |
| POST | `/wiki/rest/api/content/{id}/label` | Add labels to content |
| DELETE | `/wiki/rest/api/content/{id}/label` | Remove label from content using query parameter |
| DELETE | `/wiki/rest/api/content/{id}/label/{label}` | Remove label from content |
| GET | `/wiki/rest/api/content/{id}/notification/child-created` | Get watches for page |
| GET | `/wiki/rest/api/content/{id}/notification/created` | Get watches for space |
| POST | `/wiki/rest/api/content/{id}/pagehierarchy/copy` | Copy page hierarchy |
| POST | `/wiki/rest/api/content/{id}/copy` | Copy single page |
| POST | `/wiki/rest/api/content/{id}/permission/check` | Check content permissions |
| GET | `/wiki/rest/api/content/{id}/restriction` | Get restrictions |
| PUT | `/wiki/rest/api/content/{id}/restriction` | Update restrictions |
| POST | `/wiki/rest/api/content/{id}/restriction` | Add restrictions |
| DELETE | `/wiki/rest/api/content/{id}/restriction` | Delete restrictions |
| GET | `/wiki/rest/api/content/{id}/restriction/byOperation` | Get restrictions by operation |
| GET | `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}` | Get restrictions for operation |
| GET | `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}` | Get content restriction status for group |
| PUT | `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}` | Add group to content restriction |
| DELETE | `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}` | Remove group from content restriction |
| GET | `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user` | Get content restriction status for user |
| PUT | `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user` | Add user to content restriction |
| DELETE | `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user` | Remove user from content restriction |
| GET | `/wiki/rest/api/content/{id}/state` | Get content state |
| PUT | `/wiki/rest/api/content/{id}/state` | Set the content state of a content and publishes a new version of the content. |
| DELETE | `/wiki/rest/api/content/{id}/state` | Removes the content state of a content and publishes a new version. |
| GET | `/wiki/rest/api/content/{id}/state/available` | Gets available content states for content. |
| POST | `/wiki/rest/api/content/{id}/version` | Restore content version |
| DELETE | `/wiki/rest/api/content/{id}/version/{versionNumber}` | Delete content version |
| GET | `/wiki/rest/api/content-states` | Get Custom Content States |
| POST | `/wiki/rest/api/contentbody/convert/async/{to}` | Asynchronously convert content body |
| GET | `/wiki/rest/api/contentbody/convert/async/{id}` | Get asynchronously converted content body from the id or the current status of the task. |
| POST | `/wiki/rest/api/contentbody/convert/async/bulk/tasks` | Create asynchronous content body conversion tasks in bulk |
| GET | `/wiki/rest/api/contentbody/convert/async/bulk/tasks` | Get asynchronous content body conversion task result in bulk |
| GET | `/wiki/rest/api/label` | Get label information |
| GET | `/wiki/rest/api/group` | Get groups |
| POST | `/wiki/rest/api/group` | Create new user group |
| GET | `/wiki/rest/api/group/by-id` | Get group |
| DELETE | `/wiki/rest/api/group/by-id` | Delete user group |
| GET | `/wiki/rest/api/group/picker` | Search groups by partial query |
| GET | `/wiki/rest/api/group/{groupId}/membersByGroupId` | Get group members |

…and 70 more operations. They are listed in full on the page.

## Machine-readable artifacts (6)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/openapi/confluence-rest-v1-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/confluence/refs/heads/main/overlays/confluence-rest-v1-overlay.yaml
- **APIReference** — https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
- **Documentation** — https://developer.atlassian.com/cloud/confluence/rest/v1/intro/
- **Authentication** — https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/
- **GettingStarted** — https://developer.atlassian.com/cloud/confluence/getting-started/

## Other Confluence APIs (12)

- [Confluence Content Properties API](https://apis.io/apis/confluence/confluence-content-properties-api/)
- [Confluence Search API](https://apis.io/apis/confluence/confluence-search-api/)
- [Confluence Content API](https://apis.io/apis/confluence/confluence-content-api/)
- [Confluence Space API](https://apis.io/apis/confluence/confluence-space-api/)
- [Confluence Content Labels API](https://apis.io/apis/confluence/confluence-content-labels-api/)
- [Confluence Analytics API](https://apis.io/apis/confluence/confluence-analytics-api/)
- [Confluence Audit API](https://apis.io/apis/confluence/confluence-audit-api/)
- [Confluence Template API](https://apis.io/apis/confluence/confluence-template-api/)
- [Confluence Group API](https://apis.io/apis/confluence/confluence-group-api/)
- [Confluence Users API](https://apis.io/apis/confluence/confluence-users-api/)
- [Confluence Content States API](https://apis.io/apis/confluence/confluence-content-states-api/)
- [Confluence Content Restrictions API](https://apis.io/apis/confluence/confluence-content-restrictions-api/)

## Tags

Search, Content, User, Group, Audit, Templates, Restrictions, Watchers

---

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