{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Content API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Content",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Get Cache Content Uri",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/repositories/:workspace/:repo_slug/pipelines-config/caches/:cache_uuid/content-uri",
"params": [
{
"name": "workspace",
"value": "",
"type": "path",
"description": "The account."
},
{
"name": "repo_slug",
"value": "",
"type": "path",
"description": "The repository."
},
{
"name": "cache_uuid",
"value": "",
"type": "path",
"description": "The UUID of the cache."
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://auth.atlassian.com/authorize",
"accessTokenUrl": "https://auth.atlassian.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "This API operation retrieves a temporary content URI for accessing a specific pipeline cache in a Bitbucket repository. By providing the workspace ID, repository slug, and cache UUID as path parameters, you can obtain a pre-signed URL that allows direct access to download the cached content. This is useful for retrieving build artifacts, dependencies, or other cached data that was stored during previous pipeline executions, enabling faster build times by reusing previously downloaded or generate"
},
{
"info": {
"name": "Atlassian Search Content by Cql",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/search",
"params": [
{
"name": "cql",
"value": "",
"type": "query",
"description": "The CQL string that is used to find the requested content."
},
{
"name": "cqlcontext",
"value": "",
"type": "query",
"description": "The space, content, and content status to execute the search against.\nSpecify this as an object with the following properties:\n\n- `spaceKey` Key of the space to search against. Optional.\n- `contentId` ID of the content to search against. Optional. Must\nbe in the space spacified by `spaceKey`.\n- `contentStatuses` Content statuses to search against. Optional."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
},
{
"name": "cursor",
"value": "",
"type": "query",
"description": "Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of content objects to return per page.\nNote, this may be restricted by fixed system limits."
}
]
},
"docs": "This API operation allows you to search for Confluence content using the Confluence Query Language (CQL), providing a powerful and flexible way to retrieve pages, blog posts, attachments, and other content types based on specific criteria. By sending a GET request to the /wiki/rest/api/content/search endpoint with a CQL query string parameter, you can filter content by various attributes such as type, space, creator, creation date, labels, title text, or any combination of these conditions. The "
},
{
"info": {
"name": "Atlassian Get Content by Id",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be returned. If you don't know the content ID,\nuse [Get content](#api-content-get) and filter the results."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Filter the results to a set of content based on their status.\nIf set to `any`, content with any status is returned. Note, the\n`historical` status is currently not supported."
},
{
"name": "version",
"value": "",
"type": "query",
"description": "The version number of the content to be returned."
},
{
"name": "embeddedContentRender",
"value": "",
"type": "query",
"description": "The version of embedded content (e.g. attachments) to render.\n\n- current renders the latest version of the embedded content.\n- version-at-save renders the version of the embedded content\nat the time of save."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\nMaximum sub-expansions allowed is `8`.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
},
{
"name": "trigger",
"value": "",
"type": "query",
"description": "If set to `viewed`, the request will trigger a 'viewed' event for the content.\nWhen this event is triggered, the page/blogpost will appear on the 'Recently visited'\ntab of the user's Confluence dashboard."
}
]
},
"docs": "The Get Content By Id operation retrieves a single piece of content from Atlassian Confluence using its unique identifier. This REST API endpoint accepts the content ID as a path parameter and returns detailed information about the specified content, including its type (page, blog post, comment, etc.), title, body, version information, space details, metadata, and associated properties. The response can be customized using query parameters to expand specific fields, limit the body representation"
},
{
"info": {
"name": "Atlassian Update Content",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be updated."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The updated status of the content. Use this parameter to change the\nstatus of a piece of content without passing the entire request body."
},
{
"name": "conflictPolicy",
"value": "",
"type": "query",
"description": "The action that should be taken when conflicts are discovered.\nOnly used when publishing a draft page."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API operation updates an existing piece of content in Atlassian Confluence by sending a PUT request to the specified content ID endpoint. It allows you to modify various aspects of content such as the title, body, version number, and metadata of pages, blog posts, or other content types within your Confluence instance. The operation requires you to provide the complete updated content object in the request body, including mandatory fields like version information to ensure proper conflict h"
},
{
"info": {
"name": "Atlassian Delete Content",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be deleted."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Set this to `trashed`, if the content's status is `trashed` and you want to purge it."
}
]
},
"docs": "Deletes a piece of content from Confluence by specifying its unique identifier in the URL path. When executed, this operation permanently removes the content item, which can include pages, blog posts, comments, or attachments, from the Confluence space. The deletion is typically irreversible through the API, though Confluence may retain the content in trash for a limited time depending on instance configuration. This endpoint requires appropriate permissions, as users must have delete rights for"
},
{
"info": {
"name": "Atlassian Get Content Children",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/child",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its children."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the children to expand, where:\n\n- `attachment` returns all attachments for the content.\n- `comments` returns all comments for the content.\n- `page` returns all child pages of the content.\n- Custom content types that are provided by apps are also supported."
},
{
"name": "parentVersion",
"value": "",
"type": "query",
"description": "The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version."
}
]
},
"docs": "This API operation retrieves the direct children of a specified Confluence content item by its ID. When called with a GET request to the endpoint, it returns a paginated list of child pages, comments, or attachments depending on the parent content type. The operation supports query parameters to filter results by child content type, expand additional properties, set pagination limits, and sort the returned children. This is commonly used to navigate the content hierarchy in Confluence, such as r"
},
{
"info": {
"name": "Atlassian Get Content Comments",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/child/comment",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its comments."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
},
{
"name": "parentVersion",
"value": "",
"type": "query",
"description": "The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The starting index of the returned comments."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of comments to return per page. Note,\nthis may be restricted by fixed system limits."
},
{
"name": "location",
"value": "",
"type": "query",
"description": "The location of the comments in the page. Multiple locations can be specified.\nIf no location is specified, comments from all locations are returned."
},
{
"name": "depth",
"value": "",
"type": "query",
"description": "Currently, this parameter is not used.\nComments are returned at the root level only."
}
]
},
"docs": "This API operation retrieves all comments that are children of a specific piece of content in Atlassian Confluence. By making a GET request to the endpoint with a content ID, you can fetch a paginated list of comments associated with that content, which may include inline comments, page comments, or footer comments. The response typically includes comment metadata such as the comment body, author information, creation date, modification history, and version details. This endpoint is useful for a"
},
{
"info": {
"name": "Atlassian Get Content Children by Type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/child/:type",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its children."
},
{
"name": "type",
"value": "",
"type": "path",
"description": "The type of children to return."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
},
{
"name": "parentVersion",
"value": "",
"type": "query",
"description": "The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The starting index of the returned content."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of content to return per page. Note,\nthis may be restricted by fixed system limits."
}
]
},
"docs": "This API operation retrieves child content of a specific type for a given Confluence page or content item. By specifying the parent content ID and the desired child type (such as page, comment, or attachment) in the URL path, the endpoint returns a paginated list of all child elements matching that type. This is useful for navigating content hierarchies, accessing page comments, retrieving attachments, or discovering child pages within a Confluence space structure. The response includes metadata"
},
{
"info": {
"name": "Atlassian Get Content Descendants",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/descendant",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its descendants."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the children to\nexpand, where:\n\n- `attachment` returns all attachments for the content.\n- `comments` returns all comments for the content.\n- `page` returns all child pages of the content."
}
]
},
"docs": "This API operation retrieves all descendants of a specified Confluence content item by its ID. Descendants include all child pages, nested subpages, comments, and attachments that exist below the specified content in the content hierarchy tree. The endpoint returns a paginated list of content objects that are hierarchically related to the parent content, allowing developers to traverse and map the complete content structure beneath a given page or blog post. This is particularly useful for opera"
},
{
"info": {
"name": "Atlassian Get Content History",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/history",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its history."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content history to expand.\nMaximum sub-expansions allowed is `8`.\n\n- `lastUpdated` returns information about the most recent update of the content,\nincluding who updated it and when it was updated.\n- `previousVersion` returns information about the update prior to the current content\nupdate. For this method, it contains the same information as `lastUpdated`.\n- `contributors` returns all of the users who have contributed to the content.\n- `nextVersion` This parameter is not used for this method."
}
]
},
"docs": "This operation retrieves the version history and other historical metadata for a specific piece of Confluence content identified by its unique ID. When called, it returns information about who created and last modified the content, timestamps for these actions, version numbers, and potentially contributor details. This is useful for tracking changes, auditing content modifications, understanding content evolution over time, and displaying version information to users. The endpoint follows RESTfu"
},
{
"info": {
"name": "Atlassian Get Labels for Content",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/label",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its labels."
},
{
"name": "prefix",
"value": "",
"type": "query",
"description": "Filters the results to labels with the specified prefix. If this parameter\nis not specified, then labels with any prefix will be returned.\n\n- `global` prefix is used by default when a user adds a label\nvia the UI.\n- `my` prefix can be explicitly added by a user when adding a label\nvia the UI, e.g. 'my:example-label'. Also, when a page is selected as\na favourite, the 'my:favourite' label is automatically added.\n- `team` can used when adding labels via [Add labels to content](#api-content-id-label-post)\nbut is not used in the UI."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The starting index of the returned labels."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of labels to return per page. Note,\nthis may be restricted by fixed system limits."
}
]
},
"docs": "This API operation retrieves all labels that have been applied to a specific piece of Confluence content identified by its unique ID. When you make a GET request to this endpoint, it returns a collection of labels associated with the specified content, which can include both user-created labels and system-generated ones. Labels in Confluence are used for categorization, organization, and searchability of content such as pages, blog posts, and attachments. The response typically includes details "
},
{
"info": {
"name": "Atlassian Add Labels to Content",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/label",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that will have labels added to it."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API operation allows you to add one or more labels to a specific piece of Confluence content by making a POST request to the endpoint with the content's unique identifier. Labels are metadata tags that help organize, categorize, and improve the discoverability of pages, blog posts, and other content within Confluence. When calling this endpoint, you must provide the content ID in the URL path and include an array of label objects in the request body, specifying properties such as the label "
},
{
"info": {
"name": "Atlassian Remove Label From Content Using Query Parameter",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/label",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the label will be removed from."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "The name of the label to be removed."
}
]
},
"docs": "This API operation removes a label from a specific piece of Confluence content by specifying the content ID in the URL path and the label name as a query parameter. When executed with a DELETE HTTP method, it allows users to untag or dissociate a previously applied label from a page, blog post, or other content item in Confluence. The operation requires appropriate permissions to modify labels on the target content and will return a success response once the label has been successfully removed f"
},
{
"info": {
"name": "Atlassian Remove Label From Content",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/label/:label",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the label will be removed from."
},
{
"name": "label",
"value": "",
"type": "path",
"description": "The name of the label to be removed."
}
]
},
"docs": "Removes a specific label from a Confluence content item identified by its content ID. This DELETE operation targets the endpoint /wiki/rest/api/content/{id}/label/{label} where {id} represents the unique identifier of the content (such as a page or blog post) and {label} is the name of the label to be removed. When executed successfully, the API removes the association between the specified label and the content, effectively unlabeling that content item. This operation is useful for content mana"
},
{
"info": {
"name": "Atlassian Check Content Permissions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/permission/check",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to check permissions against."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Check if a user or a group can perform an operation to the specified content. The `operation` to check
must be provided. The user’s account ID or the ID of the group can be provided in the `subject` to check
permissions against a specified user or group. The following permission checks are done to make sure that the
user or group has the proper access:
- site permissions
- space permissions
- content restrictions
**[Permissions](https://confluence.atlassian.com/x/_Ao"
},
{
"info": {
"name": "Atlassian Get Content Properties",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/property",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its properties."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "The key of the content property."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to\nexpand. By default, the `version` object is expanded.\n\n- `content` returns the content that the property is stored against.\n- `version` returns information about the version of the property, such\nas the version number, when it was created, etc."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The starting index of the returned properties."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of properties to return per page.\nNote, this may be restricted by fixed system limits."
}
]
},
"docs": "This API operation retrieves all properties associated with a specific Confluence content item identified by its unique ID. Properties are custom key-value pairs that can be attached to content for storing additional metadata or application-specific information. The endpoint returns a paginated list of property objects, each containing the property key, value, and version information. This is useful for applications that need to read custom data attached to pages, blog posts, or other Confluence"
},
{
"info": {
"name": "Atlassian Create Content Property",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/property",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to add the property to."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new content property for an existing Confluence content item identified by its ID. Content properties are custom key-value pairs that allow you to store additional metadata or configuration data associated with a specific piece of content such as a page, blog post, or attachment. The property must include a unique key within the scope of that content item and a value, which can be a simple string or a complex JSON object. This operation requires appropriate permissions to modify the sp"
},
{
"info": {
"name": "Atlassian Get Content Property",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for the property."
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The key of the content property."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to\nexpand. By default, the `version` object is expanded.\n\n- `content` returns the content that the property is stored against.\n- `version` returns information about the version of the property, such\nas the version number, when it was created, etc."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Filter the results to a set of content based on their status. If set to `any`,\ncontent with any status is returned. By default it will fetch current and archived statuses `?status=current&status=archived`.\nAll supported statuses\n\n- any\n- archived\n- current\n- deleted\n- draft\n- trashed"
}
]
},
"docs": "Returns a specific property from the content identified by the content ID and property key. Content properties are custom key-value pairs that can be attached to Confluence content to store additional metadata or application-specific information. This endpoint retrieves the value and details of a single property rather than listing all properties associated with the content. The property must exist on the specified content item, and the user must have permission to view the content to access its"
},
{
"info": {
"name": "Atlassian Create Content Property for Key",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to add the property to."
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The key of the content property. Required."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new content property for the specified content ID and property key in Confluence. This endpoint allows you to store custom metadata or additional information associated with a specific piece of content by posting a JSON payload containing the property value. The property is identified by a unique key and is scoped to the individual content item, making it useful for storing application-specific data, custom attributes, or extended metadata that needs to be associated with pages, blog p"
},
{
"info": {
"name": "Atlassian Update Content Property",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the property belongs to."
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The key of the property."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing content property in Atlassian Confluence by replacing its value with new data. This PUT endpoint requires both the content ID and property key to be specified in the URL path, allowing you to modify custom metadata or additional attributes attached to a specific piece of content such as a page, blog post, or attachment. The request body must contain the new property value along with its version number to ensure proper conflict handling and maintain data integrity. This operat"
},
{
"info": {
"name": "Atlassian Delete Content Property",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/property/:key",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the property belongs to."
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The key of the property."
}
]
},
"docs": "The Delete Content Property operation removes a specific property from a Confluence content item by making a DELETE request to the endpoint with the content ID and property key as path parameters. This API call permanently deletes custom metadata or additional information that was previously attached to a page, blog post, or other content type, allowing developers to clean up obsolete properties or manage content attributes programmatically. Authentication is required, and successful deletion ty"
},
{
"info": {
"name": "Atlassian Get Content Restriction Status for Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/group/:groupName",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that the restriction applies to."
},
{
"name": "groupName",
"value": "",
"type": "path",
"description": "The name of the group to be queried for whether the content restriction\napplies to it."
}
]
},
"docs": "The Atlassian Confluence Content API endpoint `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}` using the GET method retrieves the restriction status for a specific group on a particular piece of content. This operation allows administrators and authorized users to check whether a designated group has restrictions applied for a specific operation (such as read or update) on content identified by its unique ID. The endpoint requires three path parameters: the "
},
{
"info": {
"name": "Atlassian Add Group to Content Restriction",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/group/:groupName",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that the restriction applies to."
},
{
"name": "groupName",
"value": "",
"type": "path",
"description": "The name of the group to add to the content restriction."
}
]
},
"docs": "The PUT operation on the Atlassian Confluence Content API endpoint `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}` adds a specified group to an existing content restriction for a particular operation type. This allows administrators to grant a group access to perform specific operations (such as read, update, or delete) on restricted Confluence content by including the group in the restriction's allowed list. The endpoint requires three path parameters: the"
},
{
"info": {
"name": "Atlassian Remove Group From Content Restriction",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/group/:groupName",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that the restriction applies to."
},
{
"name": "groupName",
"value": "",
"type": "path",
"description": "The name of the group to remove from the content restriction."
}
]
},
"docs": "This API operation removes a specific group from content restrictions for a given operation on a Confluence page or blog post. By sending a DELETE request to this endpoint with the content ID, operation key (such as 'read' or 'update'), and group name, administrators can revoke the specified group's access permissions for that particular operation on the content. This is useful for managing granular access control when you need to remove a group's ability to perform specific actions on restricte"
},
{
"info": {
"name": "Atlassian Get Content Restriction Status for Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/byGroupId/:groupId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that the restriction applies to."
},
{
"name": "groupId",
"value": "",
"type": "path",
"description": "The id of the group to be queried for whether the content restriction\napplies to it."
}
]
},
"docs": "This API endpoint retrieves the restriction status for a specific group on a piece of Confluence content. It requires three path parameters: the content ID, an operation key (typically 'read' or 'update'), and a group ID. When called, it returns information about whether the specified group has restrictions applied for the given operation on that content, helping administrators and developers understand access control configurations. This is useful for auditing permissions, validating security p"
},
{
"info": {
"name": "Atlassian Add Group to Content Restriction",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/byGroupId/:groupId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that the restriction applies to."
},
{
"name": "groupId",
"value": "",
"type": "path",
"description": "The groupId of the group to add to the content restriction."
}
]
},
"docs": "This PUT operation adds a specified group to content restrictions for a particular operation on a Confluence page or blog post. The endpoint requires three path parameters: the content ID, an operation key (such as 'read' or 'update'), and the group ID to be added to the restriction. When executed, it grants the specified group permission to perform the designated operation on the content, effectively managing fine-grained access control at the group level. This is useful for administrators who "
},
{
"info": {
"name": "Atlassian Remove Group From Content Restriction",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/byGroupId/:groupId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that the restriction applies to."
},
{
"name": "groupId",
"value": "",
"type": "path",
"description": "The id of the group to remove from the content restriction."
}
]
},
"docs": "This API operation removes a specific group from content restrictions in Atlassian Confluence by deleting the association between a group and an operation-based restriction on a particular piece of content. It requires three path parameters: the content ID identifying the restricted content, the operationKey specifying the type of operation (such as read or update), and the groupId representing the group to be removed from the restriction. When executed successfully, this DELETE request revokes "
},
{
"info": {
"name": "Atlassian Get Content Restriction Status for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that is restricted."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
{
"name": "username",
"value": "",
"type": "query",
"description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
{
"name": "accountId",
"value": "",
"type": "query",
"description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
}
]
},
"docs": "Retrieves the restriction status for a specific user on a piece of Confluence content based on a given operation key. This endpoint allows you to check whether a particular user has access to perform a specific operation (such as read, update, or delete) on content identified by its ID. The operation key parameter specifies which type of operation restriction to check, while the request targets a specific user to determine if content restrictions apply to them. This is useful for administrators "
},
{
"info": {
"name": "Atlassian Add User to Content Restriction",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that the restriction applies to."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
{
"name": "username",
"value": "",
"type": "query",
"description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
{
"name": "accountId",
"value": "",
"type": "query",
"description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
}
]
},
"docs": "Updates content restrictions by adding a user to a specific operation-based restriction on a Confluence content item. This endpoint allows administrators to grant a particular user permission to perform a specified operation (such as 'read' or 'update') on restricted content by adding them to the allowlist for that operation. The request requires the content ID, the operation key (the type of restriction being modified), and the user details to be added. This is useful for managing granular acce"
},
{
"info": {
"name": "Atlassian Remove User From Content Restriction",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/restriction/byOperation/:operationKey/user",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the restriction applies to."
},
{
"name": "operationKey",
"value": "",
"type": "path",
"description": "The operation that the restriction applies to."
},
{
"name": "key",
"value": "",
"type": "query",
"description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
{
"name": "username",
"value": "",
"type": "query",
"description": "This parameter is no longer available and will be removed from the documentation soon.\nUse `accountId` instead.\nSee the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
{
"name": "accountId",
"value": "",
"type": "query",
"description": "The account ID of the user. The accountId uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`."
}
]
},
"docs": "This API operation removes a specific user from content restrictions for a given operation type in Atlassian Confluence. By making a DELETE request to the endpoint with the content ID, operation key (such as 'read' or 'update'), and user account ID as parameters, administrators can revoke previously granted or denied permissions for that user on the specified content. This is useful for managing access control when a user's permissions need to be changed or when cleaning up outdated restrictions"
},
{
"info": {
"name": "Atlassian Get Content State",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/state",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the content whose content state is of interest."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Set status to one of [current,draft,archived]. Default value is current."
}
]
},
"docs": "This API operation retrieves the current state of a specific Confluence content item by its unique identifier. When called, it returns information about the content's workflow state, including details such as the state name, color coding, and any associated metadata that indicates where the content sits within its defined lifecycle or approval process. This is particularly useful for tracking content through editorial workflows, publication processes, or custom state management systems configure"
},
{
"info": {
"name": "Atlassian Set the Content State of Content and Publishes New Version of the Content",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/state",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Id of the content whose content state is to be set."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Status of content onto which state will be placed. If draft, then draft state will change.\nIf current, state will be placed onto a new version of the content with same body as previous version."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API operation allows you to set or update the content state of a specific Confluence page or blog post by its ID, which triggers the creation and publication of a new version of that content. When invoked via a PUT request to the endpoint, it accepts the content ID as a path parameter and the desired state information in the request body, then applies that state to the content item while automatically incrementing its version number. This is particularly useful for implementing workflow sta"
},
{
"info": {
"name": "Atlassian Removes the Content State of Content and Publishes New Version",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/state",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The Id of the content whose content state is to be set."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "status of content state from which to delete state. Can be draft or archived"
}
]
},
"docs": "This API operation removes the current content state from a specified Confluence page or blog post and automatically publishes a new version of that content. By sending a DELETE request to the endpoint with the content ID, the system clears any workflow or review state that was previously applied to the content item, essentially resetting it to a stateless condition. This action is irreversible and creates a new version in the content's history, allowing teams to track when state information was"
},
{
"info": {
"name": "Atlassian Gets Available Content States for Content",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/state/available",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "id of content to get available states for"
}
]
},
"docs": "This API endpoint retrieves all available content states that can be applied to a specific piece of content in Atlassian Confluence. By providing the content ID in the path parameter, users can query which workflow states or status options are accessible for that particular content item, helping them understand what state transitions are possible. This is useful for managing content workflows, determining valid state changes, and building integrations that need to programmatically manage content"
},
{
"info": {
"name": "Atlassian Get Content Versions",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/version",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its versions."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The starting index of the returned versions."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of versions to return per page.\nNote, this may be restricted by fixed system limits."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand. By default, the `content`\nobject is expanded.\n\n- `collaborators` returns the users that collaborated on the version.\n- `content` returns the content for the version."
}
]
},
"docs": "This API operation retrieves version history information for a specific piece of Confluence content identified by its unique ID. When called, it returns a paginated list of all versions associated with the content, including details such as version numbers, creation dates, authors, and version messages. The endpoint supports query parameters to filter results, limit the number of versions returned, and navigate through pages of version history. This is particularly useful for tracking changes ma"
},
{
"info": {
"name": "Atlassian Restore Content Version",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/version",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content for which the history will be restored."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand. By default, the `content`\nobject is expanded.\n\n- `collaborators` returns the users that collaborated on the version.\n- `content` returns the content for the version."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The Restore Content Version operation is a POST request to the Atlassian Confluence Content API endpoint /wiki/rest/api/content/{id}/version that allows you to restore a previously saved version of a specific piece of content by its ID. This operation takes the content ID as a path parameter and requires authentication with appropriate permissions to modify the content. When executed, it reverts the current content back to a specified historical version, effectively making that older version the"
},
{
"info": {
"name": "Atlassian Get Content Version",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/version/:versionNumber",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its version."
},
{
"name": "versionNumber",
"value": "",
"type": "path",
"description": "The number of the version to be retrieved."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand. By default, the `content`\nobject is expanded.\n\n- `collaborators` returns the users that collaborated on the version.\n- `content` returns the content for the version."
}
]
},
"docs": "Returns a specific version of a piece of content identified by its content ID and version number. This operation retrieves historical versions of Confluence content such as pages or blog posts, allowing users to view previous iterations and track changes over time. The endpoint requires both the unique content identifier and the specific version number to return the requested content version along with its metadata, body content, and version details. This is particularly useful for auditing purp"
},
{
"info": {
"name": "Atlassian Delete Content Version",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/version/:versionNumber",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the version will be deleted from."
},
{
"name": "versionNumber",
"value": "",
"type": "path",
"description": "The number of the version to be deleted. The version number starts\nfrom 1 up to current version."
}
]
},
"docs": "This API operation allows you to delete a specific version of a Confluence content page by providing both the content ID and the version number you wish to remove. When executed, it permanently removes that particular historical version from the content's version history while preserving other versions, enabling content administrators to clean up unwanted or erroneous page revisions. The operation requires appropriate permissions and uses the DELETE HTTP method with the content ID and version nu"
},
{
"info": {
"name": "Atlassian Convert Content Body",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/contentbody/convert/:to",
"params": [
{
"name": "to",
"value": "",
"type": "path",
"description": "The name of the target format for the content body."
},
{
"name": "spaceKeyContext",
"value": "",
"type": "query",
"description": "The space key used for resolving embedded content (page includes,\nfiles, and links) in the content body. For example, if the source content\ncontains the link ``\nand the `spaceKeyContext=TEST` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the \"TEST\" space."
},
{
"name": "contentIdContext",
"value": "",
"type": "query",
"description": "The content ID used to find the space for resolving embedded content\n(page includes, files, and links) in the content body. For example,\nif the source content contains the link ``\nand the `contentIdContext=123` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the same space\nthat has the content with ID=123. Note, `spaceKeyContext` will be ignored\nif this parameter is provided."
},
{
"name": "embeddedContentRender",
"value": "",
"type": "query",
"description": "Mode used for rendering embedded content, like attachments.\n\n- `current` renders the embedded content using the latest version.\n- `version-at-save` renders the embedded content using the version at\nthe time of save."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Converts a content body from one format to another format.
Supported conversions:
- storage: view, export_view, styled_view, editor
- editor: storage
- view: none
- export_view: none
- styled_view: none
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
If request specifies 'contentIdContext', 'View' permission for the space, and permission to view the content."
},
{
"info": {
"name": "Atlassian Asynchronously Convert Content Body",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/contentbody/convert/async/:to",
"params": [
{
"name": "to",
"value": "",
"type": "path",
"description": "The name of the target format for the content body."
},
{
"name": "spaceKeyContext",
"value": "",
"type": "query",
"description": "The space key used for resolving embedded content (page includes,\nfiles, and links) in the content body. For example, if the source content\ncontains the link ``\nand the `spaceKeyContext=TEST` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the \"TEST\" space."
},
{
"name": "contentIdContext",
"value": "",
"type": "query",
"description": "The content ID used to find the space for resolving embedded content\n(page includes, files, and links) in the content body. For example,\nif the source content contains the link ``\nand the `contentIdContext=123` parameter is provided, then the link\nwill be converted to a link to the \"Example page\" page in the same space\nthat has the content with ID=123. Note, `spaceKeyContext` will be ignored\nif this parameter is provided."
},
{
"name": "allowCache",
"value": "",
"type": "query",
"description": "If this field is false, the cache will erase its current value and begin a new conversion.\nIf this field is true, the cache will not erase its current value, and will set the status of the\nasync conversion to RERUNNING. Once the data is updated, the status will change to COMPLETED. \nLarge macros that take long to convert, and whose data need not immediately up to date (same as previous conversion's result within last 5 minutes)\nshould set this fields to true. Cache values are stored per user per content body and expansions."
},
{
"name": "embeddedContentRender",
"value": "",
"type": "query",
"description": "Mode used for rendering embedded content, like attachments.\n\n- `current` renders the embedded content using the latest version.\n- `version-at-save` renders the embedded content using the version at\nthe time of save."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The Atlassian Confluence Content Body API endpoint `/wiki/rest/api/contentbody/convert/async/{to}` allows users to asynchronously convert content body from one format to another by making a POST request. The `{to}` path parameter specifies the target format for the conversion, such as storage, view, or editor format. This asynchronous operation is particularly useful for handling large content conversions that might take longer to process, as it allows the client to submit the conversion request"
},
{
"info": {
"name": "Atlassian Get Asynchronously Converted Content Body From the Id or the Current Status of the Task",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/contentbody/convert/async/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The asyncId of the macro task to get the converted body."
}
]
},
"docs": "This API endpoint retrieves the result of an asynchronous content body conversion operation in Atlassian Confluence using a unique task identifier. When content conversion is initiated asynchronously (such as converting between different markup formats like storage format, view format, or editor format), this GET operation allows you to check the current status of the conversion task and fetch the converted content once the operation is complete. The endpoint accepts the task ID as a path parame"
},
{
"info": {
"name": "Atlassian Archive Pages",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content/archive",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Archives a list of pages. The pages to be archived are specified as a list of content IDs.
This API accepts the archival request and returns a task ID.
The archival process happens asynchronously.
Use the /longtask/ REST API to get the copy task status.
Each content ID needs to resolve to page objects that are not already in an archived state.
The content IDs need not belong to the same space.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
'Ar"
},
{
"info": {
"name": "Atlassian Publish Legacy Draft",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content/blueprint/instance/:draftId",
"params": [
{
"name": "draftId",
"value": "",
"type": "path",
"description": "The ID of the draft page that was created from a blueprint.\nYou can find the `draftId` in the Confluence application by\nopening the draft page and checking the page URL."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of the content to be updated, i.e. the draft. This is set\nto 'draft' by default, so you shouldn't need to specify it."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Publishes a legacy draft of a page created from a blueprint. Legacy drafts
will eventually be removed in favor of shared drafts. For now, this method
works the same as [Publish shared draft](#api-content-blueprint-instance-draftId-put).
By default, the following objects are expanded: `body.storage`, `history`, `space`, `version`, `ancestors`.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the draft and 'Add' permission for the spa"
},
{
"info": {
"name": "Atlassian Publish Shared Draft",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/wiki/rest/api/content/blueprint/instance/:draftId",
"params": [
{
"name": "draftId",
"value": "",
"type": "path",
"description": "The ID of the draft page that was created from a blueprint.\nYou can find the `draftId` in the Confluence application by\nopening the draft page and checking the page URL."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "The status of the content to be updated, i.e. the draft. This is set\nto 'draft' by default, so you shouldn't need to specify it."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Publishes a shared draft of a page created from a blueprint.
By default, the following objects are expanded: `body.storage`, `history`, `space`, `version`, `ancestors`.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the draft and 'Add' permission for the space that
the content will be created in."
},
{
"info": {
"name": "Atlassian Get Content",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content",
"params": [
{
"name": "type",
"value": "",
"type": "query",
"description": "The type of content to return. For example:\n - page\n - blogpost"
},
{
"name": "spaceKey",
"value": "",
"type": "query",
"description": "The key of the space to be queried for its content."
},
{
"name": "title",
"value": "",
"type": "query",
"description": "The title of the page to be returned. Required for page type."
},
{
"name": "status",
"value": "",
"type": "query",
"description": "Filter the results to a set of content based on their status. If set to `any`,\ncontent with any status is returned. Note, the `historical` status is currently\nnot supported."
},
{
"name": "postingDay",
"value": "",
"type": "query",
"description": "The posting date of the blog post to be returned. Required for\nblogpost type. Format: yyyy-mm-dd."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\nMaximum sub-expansions allowed is `8`.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
},
{
"name": "trigger",
"value": "",
"type": "query",
"description": "If set to `viewed`, the request will trigger a 'viewed' event for the content.\nWhen this event is triggered, the page/blogpost will appear on the 'Recently visited'\ntab of the user's Confluence dashboard."
},
{
"name": "orderby",
"value": "",
"type": "query",
"description": "Orders the content by a particular field. Specify the field and sort direction for\nthis parameter, as follows: 'fieldpath asc/desc'. For example, 'history.createdDate desc'."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The starting index of the returned content."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of content objects to return per page.\nNote, this may be restricted by fixed system limits."
}
]
},
"docs": "Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
Returns all content in a Confluence instance.
By default, the following objects are expanded: `space`, `history`, `version`.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to access the Confluence site ('Can use' global permission).
Only content that the user has permission to view will be returned."
},
{
"info": {
"name": "Atlassian Create Content",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content",
"params": [
{
"name": "status",
"value": "",
"type": "query",
"description": "Filter the returned content by status."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "A multi-value parameter indicating which properties of the content to expand.\nMaximum sub-expansions allowed is `8`.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
Creates a new piece of content or publishes an existing draft.
To publish a draft, add the `id` and `status` properties to the body of the request.
Set the `id` to the ID of the draft and set the `status` to 'current'. When the
request is sent, a new piece of content will be created and the metadata from the
draft will be transferred into it.
By default, the follo"
}
]
}
],
"bundled": true
}