About

This is the reference for the Confluence Cloud REST API. This API is the primary way to get and modify data in Confluence Cloud, whether you are developing an app or any other integration. Use it to interact with Confluence entities, like pages and blog posts, spaces, users, groups, and more.

Authentication and authorization

Authentication: If you are building a Cloud app, authentication is implemented via JWT (see Authentication for apps). Otherwise, if you are authenticating directly against the REST API, the REST API supports basic auth (see Basic auth for REST APIs).

Authorization: If you are building a Cloud app, authorization can be implemented by scopes or by OAuth 2.0 user impersonation. Otherwise, if you are making calls directly against the REST API, authorization is based on the user used in the authentication process.

See Security overview for more details on authentication and authorization.

Status codes

The Confluence REST API uses the standard HTTP status codes.

Responses that return an error status code will also return a response body, similar to the following:

{
  "statusCode": 404,
  "data": {
    "authorized": false,
    "valid": false,
    "errors": [
      {
        "message": {
          "translation": "This is an example error message.",
          "args": []
        }
      }
    ],
    "successful": false
  },
  "message": "This is an example error message."
}

Using the REST API

Expansion: The Confluence REST API uses resource expansion: some parts of a resource are not returned unless explicitly specified. This simplifies responses and minimizes network traffic.

To expand part of a resource in a request, use the expand query parameter and specify the entities to be expanded. If you need to expand nested entities, use the . dot notation. For example, the following request will expand information about the requested content’s space and labels:

GET /wiki/rest/api/content/{id}?expand=space,metadata.labels

Pagination: The Confluence REST API uses pagination: a method that returns a response with multiple objects can only return a limited number at one time. This limits the size of responses and conserves server resources.

Use the ‘limit’ and ‘start’ query parameters to specify pagination:

  • limit is the number of objects to return per page. This may be restricted by system limits.
  • start is the index of the first item returned in the page of results. The base index is 0.

For example, the following request will return ten content objects, starting from the fifth object.

GET /wiki/rest/api/content?start=4,limit=10

Special headers:

  • X-Atlassian-Token: no-check request header must be specified for methods that are protected from Cross Site Request Forgery (XSRF/CSRF) attacks. This is stated in the method description, if required. For more information, see this KB article.

Capabilities

Webhooks: A webhook is a user-defined callback over HTTP. You can use Confluence webhooks to notify your app or web application when certain events occur in Confluence. For example, when a page is created or updated. To learn more, see Webhooks.

Content properties: Content properties are a key-value storage associated with a piece of Confluence content. If you are building an app, this is one form of persistence that you can use. You can use the Confluence REST API to get, update, and delete content properties. To learn more, see Content properties in the REST API.

CQL: The Confluence Query Language (CQL) allows you to perform complex searches for content using an SQL-like syntax in the search resource. To learn more, see Advanced searching using CQL.

Audit

Get audit records

GET /wiki/rest/api/audit

Returns all records in the audit log, optionally for a certain date range. This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator’s guide.

Permissions required: ‘Confluence Administrator’ global permission.

Apps cannot access this REST resource.

Response content type: application/json

Request

Query parameters

endDate

string

Filters the results to the records on or before the endDate. The endDate must be specified as a timestamp.

limit

integer

The maximum number of records to return per page. Note, this may be restricted by fixed system limits.

Default: 1000, Minimum: 0

searchString

string

Filters the results to records that have string property values matching the searchString.

start

integer

The starting index of the returned records.

Default: 0, Minimum: 0

startDate

string

Filters the results to the records on or after the startDate. The startDate must be specified as a timestamp.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/audit'

Response

Returned if the requested records are returned.

403 Forbidden

Returned if the calling user does not have permission to view the audit log.

Create audit record

POST /wiki/rest/api/audit

Creates a record in the audit log.

Permissions required: ‘Confluence Administrator’ global permission.

Apps cannot access this REST resource.

Response content type: application/json

Request

Body parameters

affectedObject

AffectedObject

associatedObjects

[AffectedObject]

Objects that were associated with the event. For example, if the event was a space permission change then the associated object would be the space.

author REQUIRED

object

The user that actioned the event. If author is not specified, then all author properties will be set to null/empty, except for type which will be set to ‘user’.

category

string

The category of the event, which is displayed in the ‘Event type’ column on the audit log in the Confluence UI.

changedValues

[ChangedValue]

The values that were changed in the event.

creationDate

integer

The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the Confluence UI. If the creationDate is not specified, then it will be set to the timestamp for the current date-time.

description

string

A long description of the event, which is displayed in the ‘Description’ field on the audit log in the Confluence UI.

remoteAddress

string

The IP address of the computer where the event was initiated from.

summary

string

The summary of the event, which is displayed in the ‘Change’ column on the audit log in the Confluence UI.

sysAdmin

boolean

Indicates whether the event was actioned by a system administrator.

Default: false

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "affectedObject": {
        "name": "string",
        "objectType": "string"
      },
      "associatedObjects": [
        {}
      ],
      "author": {
        "displayName": "string",
        "operations": {},
        "type": "string",
        "userKey": "string",
        "username": "string"
      },
      "category": "string",
      "changedValues": [
        {
          "name": "string",
          "newValue": "string",
          "oldValue": "string"
        }
      ],
      "creationDate": 123456,
      "description": "string",
      "remoteAddress": "string",
      "summary": "string",
      "sysAdmin": true
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/audit'

Response

Returned if the record is created in the audit log.

400 Bad Request

Returned if the remoteAddress property is not specified.

Export audit records

GET /wiki/rest/api/audit/export

Exports audit records as a CSV file or ZIP file.

Permissions required: ‘Confluence Administrator’ global permission.

Apps cannot access this REST resource.

Response content type: application/zip, text/csv

Request

Query parameters

endDate

string

Filters the exported results to the records on or before the endDate. The endDate must be specified as a timestamp.

format

string

The format of the export file for the audit records.

Default: csv

Valid values:
  • csv
  • zip

searchString

string

Filters the exported results to records that have string property values matching the searchString.

startDate

string

Filters the exported results to the records on or after the startDate. The startDate must be specified as a timestamp.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/zip' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/audit/export'

Response

200 OK

Returned if the requested export of the audit records is returned.

403 Forbidden

Returned if the calling user does not have permission to view the audit log.

Get retention period

GET /wiki/rest/api/audit/retention

Returns the retention period for records in the audit log. The retention period is how long an audit record is kept for, from creation date until it is deleted.

Permissions required: ‘Confluence Administrator’ global permission.

Apps cannot access this REST resource.

Response content type: application/json

Request

There are no parameters for this request.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/audit/retention'

Response

Returned if the requested retention period is returned.

403 Forbidden

Returned if the calling user does not have permission to view the audit log.

Set retention period

PUT /wiki/rest/api/audit/retention

Sets the retention period for records in the audit log. The retention period can be set to a maximum of 20 years.

Permissions required: ‘Confluence Administrator’ global permission.

Apps cannot access this REST resource.

Response content type: application/json

Request

Body parameters

number

integer

The number of units for the retention period.

units

string

The unit of time that the retention period is measured in.

Valid values:
  • NANOS
  • MICROS
  • MILLIS
  • SECONDS
  • MINUTES
  • HOURS
  • HALF_DAYS
  • DAYS
  • WEEKS
  • MONTHS
  • YEARS
  • DECADES
  • CENTURIES
  • MILLENNIA
  • ERAS
  • FOREVER

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "number": 123456,
      "units": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/audit/retention'

Response

Returned if the retention period is updated.

403 Forbidden

Returned if the calling user does not have permission to view the audit log.

Get audit records for time period

GET /wiki/rest/api/audit/since

Returns records from the audit log, for a time period back from the current date. For example, you can use this method to get the last 3 months of records.

This contains information about events like space exports, group membership changes, app installations, etc. For more information, see Audit log in the Confluence administrator’s guide.

Permissions required: ‘Confluence Administrator’ global permission.

Apps cannot access this REST resource.

Response content type: application/json

Request

Query parameters

limit

integer

The maximum number of records to return per page. Note, this may be restricted by fixed system limits.

Default: 1000, Minimum: 0

number

integer

The number of units for the time period.

Default: 3

searchString

string

Filters the results to records that have string property values matching the searchString.

start

integer

The starting index of the returned records.

Default: 0, Minimum: 0

units

string

The unit of time that the time period is measured in.

Default: MONTHS

Valid values:
  • NANOS
  • MICROS
  • MILLIS
  • SECONDS
  • MINUTES
  • HOURS
  • HALF_DAYS
  • DAYS
  • WEEKS
  • MONTHS
  • YEARS
  • DECADES
  • CENTURIES

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/audit/since'

Response

Returned if the requested records are returned.

403 Forbidden

Returned if the calling user does not have permission to view the audit log.

Content

Get content

GET /wiki/rest/api/content

Returns all content in a Confluence instance.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission). Only content that the user has permission to view will be returned.

App scope required: READ

Response content type: application/json

Request

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content to expand. By default, the following objects are expanded: space, history, version.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

limit

integer

The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

orderby

string

Orders the content by a particular field. Specify the field and sort direction for this parameter, as follows: ‘fieldpath asc/desc’. For example, ‘history.createdDate desc’.

postingDay

string

The posting date of the blog post to be returned. Required for blogpost type. Format: yyyy-mm-dd.

spaceKey

string

The key of the space to be queried for its content.

start

integer

The starting index of the returned content.

Default: 0, Minimum: 0

status

[string]

Filter the results to a set of content based on their status. If set to any, content with any status is returned. Note, the historical status is currently not supported.

Default: current

Valid values:
  • current
  • trashed
  • draft
  • any

title

string

The title of the page to be returned. Required for page type.

trigger

string

If set to viewed, the request will trigger a ‘viewed’ event for the content. When this event is triggered, the page/blogpost will appear on the ‘Recently visited’ tab of the user’s Confluence dashboard.

Valid values:
  • viewed

type

string

The type of content to return.

Default: page

Valid values:
  • page
  • blogpost

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content'

Response

Returned if the requested list of content is returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if the calling user does not have permission to view the requested content.

Create content

POST /wiki/rest/api/content

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.

Permissions required: ‘Add’ permission for the space that the content will be created in, and permission to view the draft if publishing a draft.

App scope required: WRITE

Response content type: application/json

Request

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the new content to expand. By default, the following objects are expanded: space, history, version.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

status

string

Filter the returned content by status.

Default: current

Body parameters

ancestors

[object]

The parent content of the new content. Only one parent content id can be specified.

body

object

The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. storage.

Note, editor2 format is used by Atlassian only. anonymous_export_view is the same as ‘export_view’ format but only content viewable by an anonymous user is included.

id

string

The ID of the draft content. Required when publishing a draft.

space REQUIRED

object

The space that the content is being created in.

status

string

The status of the new content.

Default: current

Valid values:
  • current
  • trashed
  • historical
  • draft

title

string

Max length: 255

type

string

The type of the new content. Custom content types defined by apps are also supported.

Valid values:
  • page
  • blogpost
  • comment
  • attachment

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "ancestors": [
        {
          "id": "string"
        }
      ],
      "body": {
        "anonymous_export_view": {},
        "editor2": {},
        "export_view": {},
        "storage": {},
        "styled_view": {},
        "view": {
          "representation": "string",
          "value": "string"
        }
      },
      "id": "string",
      "space": {
        "key": "string"
      },
      "status": "string",
      "title": "string",
      "type": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content'

Response

200 OK schema

Returned if the content is created.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

403 Forbidden

Returned if;

  • The space that the content is being created in does not exist.
  • If the requesting user does not have permission to create content in it.

Get content by ID

GET /wiki/rest/api/content/{id}

Returns a single piece of content, like a page or a blog post.

Permissions required: Permission to view the content. If the content is a blog post, ‘View’ permission for the space is required.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be returned. If you don’t know the content ID, use Get content and filter the results.

Query parameters

embeddedContentRender

string

The version of embedded content (e.g. attachments) to render.

  • current renders the latest version of the embedded content.
  • version-at-save renders the version of the embedded content at the time of save.

Default: current

Valid values:
  • current
  • version-at-save

expand

[string]

A multi-value parameter indicating which properties of the content to expand. By default, the following objects are expanded: space, history, version.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

status

[string]

Filter the results to a set of content based on their status. If set to any, content with any status is returned. Note, the historical status is currently not supported.

Default: current

Valid values:
  • current
  • trashed
  • draft
  • any

trigger

string

If set to viewed, the request will trigger a ‘viewed’ event for the content. When this event is triggered, the page/blogpost will appear on the ‘Recently visited’ tab of the user’s Confluence dashboard.

Valid values:
  • viewed

version

integer

The version number of the content to be returned.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}'

Response

200 OK schema

Returned if the requested content is returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The requesting user does not have permission to view the content.

Update content

PUT /wiki/rest/api/content/{id}

Updates a piece of content. Use this method to update the title or body of a piece of content, change the status, change the parent page, and more.

Note, updating draft content is currently not supported.

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be updated.

Query parameters

conflictPolicy

string

The action that should be taken when conflicts are discovered. Only used when publishing a draft page.

Default: abort

Valid values:
  • abort

status

string

The updated status of the content. Use this parameter to change the status of a piece of content without passing the entire request body.

Default: current

Valid values:
  • current
  • trashed
  • historical
  • draft

Body parameters

ancestors

[object]

The new parent for the content. Only one parent content ‘id’ can be specified.

body

object

The updated body of the content. Does not apply to attachments. If you are not sure how to generate these formats, you can create a page in the Confluence application, retrieve the content using Get content, and expand the desired content format, e.g. expand=body.storage.

status

string

The updated status of the content. Note, if you change the status of a page from ‘current’ to ‘draft’ and it has an existing draft, the existing draft will be deleted in favour of the updated page.

Valid values:
  • current
  • trashed
  • historical
  • draft

title

string

The updated title of the content. If you are not changing this field, set this to the current title.

Max length: 255

type

string

The type of content. Set this to the current type of the content.

Valid values:
  • page
  • blogpost
  • comment
  • attachment

version REQUIRED

object

The new version for the updated content. Set this to the current version number incremented by one, unless you are changing the status to ‘draft’ which must have a version number of 1.

To get the current version number, use Get content by ID and retrieve version.number.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "ancestors": [
        {
          "id": "string"
        }
      ],
      "body": {
        "anonymous_export_view": {},
        "editor2": {},
        "export_view": {},
        "storage": {},
        "styled_view": {},
        "view": {
          "representation": "string",
          "value": "string"
        }
      },
      "status": "string",
      "title": "string",
      "type": "string",
      "version": {
        "number": 123456
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}'

Response

200 OK schema

Returned if the content is updated.

400 Bad Request

Returned if;

  • The request body is missing required parameters (version, type, title).
  • The type property has been set incorrectly.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if a draft with current content cannot be found when setting the status parameter to draft and the content status is current.

409 Conflict

Returned if; - The page is a draft (draft pages cannot be updated). - The version property has not been set correctly for the content type.

Delete content

DELETE /wiki/rest/api/content/{id}

Moves a piece of content to the space’s trash or purges it from the trash, depending on the content’s type and status:

  • If the content’s type is page or blogpost and its status is current, it will be trashed.
  • If the content’s type is page or blogpost and its status is trashed, the content will be purged from the trash and deleted permanently. Note, you must also set the status query parameter to trashed in your request.
  • If the content’s type is comment or attachment, it will be deleted permanently without being trashed.

Permissions required: ‘Delete’ permission for the space that the content is in, and permission to edit the content.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be deleted.

Query parameters

status

string

Set this to trashed, if the content’s status is trashed and you want to purge it.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}'

Response

200 OK

Returned if the content is successfully trashed.

204 No Content

Returned if the content is successfully purged.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The requesting user does not have permission to trash or purge the content.

Get content children

GET /wiki/rest/api/content/{id}/child

Returns a map of the direct children of a piece of content. A piece of content has different types of child content, depending on its type. These are the default parent-child content type relationships:

  • page: child content is page, comment, attachment
  • blogpost: child content is comment, attachment
  • attachment: child content is comment
  • comment: child content is attachment

Apps can override these default relationships. Apps can also introduce new content types that create new parent-child content relationships.

Note, the map will always include all child content types that are valid for the content. However, if the content has no instances of a child content type, the map will contain an empty array for that child content type.

Permissions required: ‘View’ permission for the space, and permission to view the content if it is a page.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its children.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the children to expand, where:

  • attachment returns all attachments for the content.
  • comments returns all comments for the content.
  • page returns all child pages of the content.

parentVersion

integer

The version of the parent content to retrieve children for. Currently, this only works for the latest version.

Default: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child'

Response

Returned if the requested content children are returned.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Get content children by type

GET /wiki/rest/api/content/{id}/child/{type}

Returns all children of a given type, for a piece of content. A piece of content has different types of child content, depending on its type:

  • page: child content is page, comment, attachment
  • blogpost: child content is comment, attachment
  • attachment: child content is comment
  • comment: child content is attachment

Custom content types that are provided by apps can also be returned.

Note, this method only returns direct children. To return children at all levels, use Get descendants by type.

Permissions required: ‘View’ permission for the space, and permission to view the content if it is a page.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its children.

type REQUIRED

string

The type of children to return.

Valid values:
  • page
  • comment
  • attachment

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the new content to expand.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

limit

integer

The maximum number of content to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

parentVersion

integer

The version of the parent content to retrieve children for. Currently, this only works for the latest version.

Default: 0, Minimum: 0

start

integer

The starting index of the returned content.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child/{type}'

Response

Returned if the requested content is returned.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Get attachments

GET /wiki/rest/api/content/{id}/child/attachment

Returns the attachments for a piece of content.

Permissions required: Permission to view the content. If the content is a blog post, ‘View’ permission for the space is required.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its attachments.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the attachments to expand. By default, the following objects are expanded: metadata.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

filename

string

Filter the results to attachments that match the filename.

limit

integer

The maximum number of attachments to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

mediaType

string

Filter the results to attachments that match the media type.

start

integer

The starting index of the returned attachments.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child/attachment'

Response

Returned if the requested attachments are returned.

404 Not Found

Returned if;

  • There is no parent content with the given ID.
  • The calling user does not have permission to view the parent content.

Create attachment

POST /wiki/rest/api/content/{id}/child/attachment

Adds an attachment to a piece of content. This method only adds a new attachment. If you want to update an existing attachment, use Create or update attachments.

Note, you must set a X-Atlassian-Token: nocheck header on the request for this method, otherwise it will be blocked. This protects against XSRF attacks, which is necessary as this method accepts multipart/form-data.

The media type ‘multipart/form-data’ is defined in RFC 1867. Most client libraries have classes that make it easier to implement multipart posts, like the MultiPartEntity Java class provided by Apache HTTP Components.

Example: This curl command attaches a file (‘example.txt’) to a container (id=‘123’) with a comment and minorEdits=true.

curl -D- \
  -u admin:admin \
  -X POST \
  -H "X-Atlassian-Token: nocheck" \
  -F "file=@example.txt" \
  -F "minorEdit=true" \
  -F "comment=Example attachment comment" \
  http://myhost/rest/api/content/123/child/attachment

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to add the attachment to.

Query parameters

status

string

The status of the content that the attachment is being added to.

Default: current

Valid values:
  • current
  • draft

Form parameters

comment

file

The comment for the attachment that is being added. If you specify a comment, then every file must have a comment and the comments must be in the same order as the files. Alternatively, don’t specify any comments.

file REQUIRED

file

The relative location and name of the attachment to be added to the content.

minorEdit REQUIRED

file

If minorEdits is set to ‘true’, no notification email or activity stream will be generated when the attachment is added to the content.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=@file/to/upload.txt' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child/attachment'

Response

Returned if the attachments were added to the content.

400 Bad Request

Returned if the content already has an attachment with the same filename.

403 Forbidden

Returned if;

  • Attachments are disabled in Confluence.
  • The calling user does not have permission to add attachments to the content.

404 Not Found

Returned if;

  • The requested content is not found.
  • The user does not have permission to view it
  • The attachment exceeds the maximum configured attachment size.

Create or update attachment

PUT /wiki/rest/api/content/{id}/child/attachment

Adds an attachment to a piece of content. If the attachment already exists for the content, then the attachment is updated (i.e. a new version of the attachment is created).

Note, you must set a X-Atlassian-Token: nocheck header on the request for this method, otherwise it will be blocked. This protects against XSRF attacks, which is necessary as this method accepts multipart/form-data.

The media type ‘multipart/form-data’ is defined in RFC 1867. Most client libraries have classes that make it easier to implement multipart posts, like the MultiPartEntity Java class provided by Apache HTTP Components.

Example: This curl command attaches a file (‘example.txt’) to a piece of content (id=‘123’) with a comment and minorEdits=true. If the ‘example.txt’ file already exists, it will update it with a new version of the attachment.

curl -D- \
  -u admin:admin \
  -X PUT \
  -H "X-Atlassian-Token: nocheck" \
  -F "file=@example.txt" \
  -F "minorEdit=true" \
  -F "comment=Example attachment comment" \
  http://myhost/rest/api/content/123/child/attachment

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to add the attachment to.

Query parameters

status

string

The status of the content that the attachment is being added to. This should always be set to ‘current’.

Default: current

Valid values:
  • current
  • draft

Form parameters

comment

file

The comment for the attachment that is being added. If you specify a comment, then every file must have a comment and the comments must be in the same order as the files. Alternatively, don’t specify any comments.

file REQUIRED

file

The relative location and name of the attachment to be added to the content.

minorEdit REQUIRED

file

If minorEdits is set to ‘true’, no notification email or activity stream will be generated when the attachment is added to the content.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=@file/to/upload.txt' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child/attachment'

Response

Returned if the attachments were added to the content.

403 Forbidden

Returned if;

  • Attachments are disabled.
  • The calling user does not have permission to add attachments to the content.

404 Not Found

Returned if;

  • The requested content is not found.
  • The user does not have permission to view it.
  • The attachment exceeds the maximum configured attachment size.

Update attachment properties

PUT /wiki/rest/api/content/{id}/child/attachment/{attachmentId}

Updates the attachment properties, i.e. the non-binary data of an attachment like the filename, media-type, comment, and parent container.

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

attachmentId REQUIRED

string

The ID of the attachment to update.

id REQUIRED

string

The ID of the content that the attachment is attached to.

Body parameters

container REQUIRED

object

The new content to attach the attachment to.

id

string

The ID of the attachment to be updated.

metadata

object

title

string

The updated name of the attachment.

Max length: 255

type

string

Set this to attachment.

Valid values:
  • attachment

version REQUIRED

object

The attachment version. Set this to the current version number of the attachment. Note, the version number only needs to be incremented when updating the actual attachment, not its properties.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "container": {
        "id": "string",
        "type": "string"
      },
      "id": "string",
      "metadata": {
        "comment": "string",
        "mediaType": "string"
      },
      "title": "string",
      "type": "string",
      "version": {
        "number": 123456
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child/attachment/{attachmentId}'

Response

200 OK schema

Returned if the attachment is updated.

400 Bad Request

Returned if;

  • The attachment id is invalid.
  • The attachment version number is invalid.

403 Forbidden

Returned if;

  • The calling user is not permitted to update or move the attachment.
  • The attachment is being moved to an invalid content type.

404 Not Found

Returned if no attachment is found for the attachment ID.

409 Conflict

Returned if the version of the supplied attachment does not match the version of the attachment stored in the database.

Update attachment data

POST /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data

Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit field.

This method is essentially the same as Create or update attachments, except that it matches the attachment ID rather than the name.

Note, you must set a X-Atlassian-Token: nocheck header on the request for this method, otherwise it will be blocked. This protects against XSRF attacks, which is necessary as this method accepts multipart/form-data.

The media type ‘multipart/form-data’ is defined in RFC 1867. Most client libraries have classes that make it easier to implement multipart posts, like the MultiPartEntity Java class provided by Apache HTTP Components.

Example: This curl command updates an attachment (id=‘att456’) that is attached
to a piece of content (id=‘123’) with a comment and minorEdits=true.

curl -D- \
  -u admin:admin \
  -X POST \
  -H "X-Atlassian-Token: nocheck" \
  -F "file=@example.txt" \
  -F "minorEdit=true" \
  -F "comment=Example attachment comment" \
  http://myhost/rest/api/content/123/child/attachment/att456/data

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

attachmentId REQUIRED

string

The ID of the attachment to update.

id REQUIRED

string

The ID of the content that the attachment is attached to.

Form parameters

comment

file

The comment for the attachment that is being added. If you specify a comment, then every file must have a comment and the comments must be in the same order as the files. Alternatively, don’t specify any comments.

file REQUIRED

file

The relative location and name of the attachment to be added to the content.

minorEdit REQUIRED

file

If minorEdits is set to ‘true’, no notification email or activity stream will be generated when the attachment is added to the content.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=@file/to/upload.txt' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child/attachment/{attachmentId}/data'

Response

200 OK schema

Returned if the attachment is updated.

400 Bad Request

Returned if the attachment id is invalid.

404 Not Found

Returned if no attachment is found for the attachment ID.

Get content comments

GET /wiki/rest/api/content/{id}/child/comment

Returns the comments on a piece of content.

Permissions required: ‘View’ permission for the space, and permission to view the content if it is a page.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its comments.

Query parameters

depth

string

Currently, this parameter is not used. Comments are returned at the root level only.

expand

[string]

A multi-value parameter indicating which properties of the attachments to expand.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

In addition, the following comment-specific expansions can be used:

  • extensions.inlineProperties returns inline comment-specific properties.
  • extensions.resolution returns the resolution status of each comment.

limit

integer

The maximum number of comments to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

location

[string]

The location of the comments in the page. Multiple locations can be specified. If no location is specified, comments from all locations are returned.

Valid values:
  • inline
  • footer
  • resolved

parentVersion

integer

The version of the parent content to retrieve children for. Currently, this only works for the latest version.

Default: 0, Minimum: 0

start

integer

The starting index of the returned comments.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child/comment'

Response

Returned if the requested comments are returned.

404 Not Found

Returned if;

  • There is no parent content with the given ID.
  • The calling user does not have permission to view the parent content.

Get content descendants

GET /wiki/rest/api/content/{id}/descendant

Returns a map of the descendants of a piece of content. This is similar to Get content children, except that this method returns child pages at all levels, rather than just the direct child pages.

A piece of content has different types of descendants, depending on its type:

  • page: descendant is page, comment, attachment
  • blogpost: descendant is comment, attachment
  • attachment: descendant is comment
  • comment: descendant is attachment

The map will always include all descendant types that are valid for the content. However, if the content has no instances of a descendant type, the map will contain an empty array for that descendant type.

Permissions required: ‘View’ permission for the space, and permission to view the content if it is a page.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its descendants.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the children to expand, where:

  • attachment returns all attachments for the content.
  • comments returns all comments for the content.
  • page returns all child pages of the content.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/descendant'

Response

Returned if the requested descendants are returned.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Get content descendants by type

GET /wiki/rest/api/content/{id}/descendant/{type}

Returns all descendants of a given type, for a piece of content. This is similar to Get content children by type, except that this method returns child pages at all levels, rather than just the direct child pages.

A piece of content has different types of descendants, depending on its type:

  • page: descendant is page, comment, attachment
  • blogpost: descendant is comment, attachment
  • attachment: descendant is comment
  • comment: descendant is attachment

Custom content types that are provided by apps can also be returned.

Permissions required: ‘View’ permission for the space, and permission to view the content if it is a page.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its descendants.

type REQUIRED

string

The type of descendants to return.

Valid values:
  • page
  • comment
  • attachment

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the new content to expand.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

limit

integer

The maximum number of content to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

start

integer

The starting index of the returned content.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/descendant/{type}'

Response

Returned if the requested content is returned.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Get history for content

GET /wiki/rest/api/content/{id}/history

Returns the most recent update for a piece of content.

Permissions required: Permission to view the content.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its history.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content history to expand.

  • lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • previousVersion returns information about the update prior to the current content update. For this method, it contains the same information as lastUpdated.
  • contributors returns all of the users who have contributed to the content.
  • nextVersion This parameter is not used for this method.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/history'

Response

Returned if the requested content history is returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Get macro body by macro ID

GET /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}

Returns the body of a macro in storage format, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters. This method is mainly used by Cloud apps.

About the macro ID: When a macro is created in a new version of content, Confluence will generate a random ID for it, unless an ID is specified (by an app). The macro ID will look similar to this: ‘50884bd9-0cb8-41d5-98be-f80943c14f96’. The ID is then persisted as new versions of content are created, and is only modified by Confluence if there are conflicting IDs.

Note, to preserve backwards compatibility this resource will also match on the hash of the macro body, even if a macro ID is found. This check will eventually become redundant, as macro IDs are generated for pages and transparently propagate out to all instances.

Permissions required: Permission to view the content that the macro is in.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID for the content that contains the macro.

macroId REQUIRED

string

The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, ‘/content/196611/version/7?expand=content.body.storage’.

version REQUIRED

integer

The version of the content that contains the macro.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}'

Response

Returned if the requested macro body is returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.
  • The macro does not exist in the specified version.
  • There is no macro matching the given macro ID or hash.

Get labels for content

GET /wiki/rest/api/content/{id}/label

Returns the labels on a piece of content.

Permissions required: ‘View’ permission for the space and permission to view the content if it is a page.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its labels.

Query parameters

limit

integer

The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0

prefix

string

Filters the results to labels with the specified prefix. If this parameter
is not specified, then labels with any prefix will be returned.

  • global prefix is used by default when a user adds a label via the UI.
  • my prefix can be explicitly added by a user when adding a label via the UI, e.g. ‘my:example-label’. Also, when a page is selected as a favourite, the ‘my:favourite’ label is automatically added.
  • team can used when adding labels via Add labels to content but is not used in the UI.

Valid values:
  • global
  • my
  • team

start

integer

The starting index of the returned labels.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/label'

Response

Returned if the requested labels are returned.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Add labels to content

POST /wiki/rest/api/content/{id}/label

Adds labels to a piece of content. Does not modify the existing labels.

Notes:

  • Labels can also be added when creating content (Create content).
  • Labels can be updated when updating content (Update content). This will delete the existing labels and replace them with the labels in the request.

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that will have labels added to it.

Body parameters

data

[LabelCreate]

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    [
      {
        "name": "string",
        "prefix": "string"
      }
    ]' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/label'

Response

Returned if the labels are added to the content.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Remove label from content using query parameter

DELETE /wiki/rest/api/content/{id}/label

Removes a label from a piece of content. This is similar to Remove label from content except that the label name is specified via a query parameter.

Use this method if the label name has “/” characters, as Remove label from content using query parameter does not accept “/” characters for the label name.

Permissions required: Permission to update the content.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that the label will be removed from.

Query parameters

name

string

The name of the label to be removed.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/label'

Response

204 No Content

Returned if the label is removed. The response body will be empty.

403 Forbidden

Returned if the calling user can view but not edit the content.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Remove label from content

DELETE /wiki/rest/api/content/{id}/label/{label}

Removes a label from a piece of content. This is similar to Remove label from content using query parameter except that the label name is specified via a path parameter.

Use this method if the label name does not have “/” characters, as the path parameter does not accept “/” characters for security reasons. Otherwise, use Remove label from content using query parameter.

Permissions required: Permission to update the content.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that the label will be removed from.

label REQUIRED

string

The name of the label to be removed.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/label/{label}'

Response

204 No Content

Returned if the label is removed. The response body will be empty.

400 Bad Request

Returned if the label name has a “/” character.

403 Forbidden

Returned if the calling user can view but not edit the content.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Get watches for page

GET /wiki/rest/api/content/{id}/notification/child-created

Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated.

If you want to manage watches for a page, use the following user methods:

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its watches.

Query parameters

limit

integer

The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0

start

integer

The starting index of the returned watches.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/notification/child-created'

Response

Returned if the requested watches are returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

Get watches for space

GET /wiki/rest/api/content/{id}/notification/created

Returns all space watches for the space that the content is in. A user that watches a space will receive receive notifications when any content in the space is updated.

If you want to manage watches for a space, use the following user methods:

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its watches.

Query parameters

limit

integer

The maximum number of watches to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0

start

integer

The starting index of the returned watches.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/notification/created'

Response

Returned if the requested watches are returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

Copy page hierarchy

POST /wiki/rest/api/content/{id}/pagehierarchy/copy

Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body. The titleOptions object defines the rules of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the copied page titles.

Response example: 


 {
      “id” : “1180606”,
      “links” : {
           “status” : “/rest/api/longtask/1180606”
      }
 }
Use the /longtask/ REST API to get the copy task status.

App scope required: WRITE

Response content type: application/json;charset=UTF-8

Request

Path parameters

id REQUIRED

string

Body parameters

copyAttachments

boolean

copyLabels

boolean

copyPermissions

boolean

copyProperties

boolean

destinationPageId

ContentId

originalPageId

ContentId

titleOptions

CopyPageHierarchyTitleOptions

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json;charset=UTF-8' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "copyAttachments": true,
      "copyLabels": true,
      "copyPermissions": true,
      "copyProperties": true,
      "destinationPageId": {},
      "originalPageId": "string",
      "titleOptions": {
        "prefix": "string",
        "replace": "string",
        "search": "string"
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/pagehierarchy/copy'

Response

200 OK

Returns a full JSON representation of a long running task

400 Bad Request

Returned if original page or destination page doesn’t exist.

403 Forbidden

Returned if the user does not have permission to create content at destination

Get content properties

GET /wiki/rest/api/content/{id}/property

Returns the properties for a piece of content. For more information about content properties, see Content properties in the REST API.

Permissions required: ‘View’ permission for the space, and permission to view the content if it is a page.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its properties.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content to expand. By default, the version object is expanded.

  • content returns the content that the property is stored against.
  • version returns information about the version of the property, such as the version number, when it was created, etc.

limit

integer

The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.

Default: 10, Minimum: 0

start

integer

The starting index of the returned properties.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property'

Response

Returned if the requested properties are returned.

404 Not Found

Returned if;

  • There is no content with the given ID
  • The calling user does not have permission to view the content.

Create content property

POST /wiki/rest/api/content/{id}/property

Creates a property for an existing piece of content. For more information about content properties, see Content properties in the REST API.

This is the same as Create content property for key except that the key is specified in the request body instead of as a path parameter.

Content properties can also be added when creating a new piece of content by including them in the metadata.properties of the request.

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to add the property to.

Body parameters

key

string

The key of the new property.

Max length: 255

value

PropertyValue

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "key": "string",
      "value": {}
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property'

Response

Returned if the content property is created.

400 Bad Request

Returned if;

  • The content already has a property with the given key.
  • The key is too long.
  • The key is empty.

403 Forbidden

Returned if the user does not have permission to edit the content with the given ID.

413 Request Entity Too Large

Returned if the value is too long.

Get content property

GET /wiki/rest/api/content/{id}/property/{key}

Returns a content property for a piece of content. For more information, see Content properties in the REST API.

Permissions required: ‘View’ permission for the space, and permission to view the content if it is a page.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for the property.

key REQUIRED

string

The key of the content property.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content to expand. By default, the version object is expanded.

  • content returns the content that the property is stored against.
  • version returns information about the version of the property, such as the version number, when it was created, etc.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}'

Response

Returned if the content property is returned.

404 Not Found

Returned if;

  • The calling user does not have permission to view the content.
  • There is no content with the given ID.
  • There is no property with the given key.

Create content property for key

POST /wiki/rest/api/content/{id}/property/{key}

Creates a property for an existing piece of content. For more information about content properties, see Content properties in the REST API.

This is the same as Create content property except that the key is specified as a path parameter instead of in the request body.

Content properties can also be added when creating a new piece of content by including them in the metadata.properties of the request.

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to add the property to.

key REQUIRED

string

The key of the content property. Required.

Body parameters

value

PropertyValue

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "value": {}
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}'

Response

Returned if the content property is created.

400 Bad Request

Returned if;

  • The content already has a property with the given key.
  • The key is too long.
  • The key is empty.

403 Forbidden

Returned if the user does not have permission to edit the content with the given ID.

413 Request Entity Too Large

Returned if the value is too long.

Update content property

PUT /wiki/rest/api/content/{id}/property/{key}

Updates an existing content property. This method will also create a new property for a piece of content, if the property key does not exist and the property version is 1. For more information about content properties, see Content properties in the REST API.

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that the property belongs to.

key REQUIRED

string

The key of the property.

Body parameters

value

object

The value of the property.

version REQUIRED

object

The version number of the property.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "value": {},
      "version": {
        "minorEdit": true,
        "number": 123456
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}'

Response

Returned if the content property is created.

400 Bad Request

Returned if;

  • The content already a property with the given key.
  • The key is too long.
  • The key is empty.

403 Forbidden

Returned if the user does not have permission to edit the content with the given ID.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.
  • There is no property with the given key and the version number is not 1.

409 Conflict

Returned if the property version is not correctly incremented.

413 Request Entity Too Large

Returned if the value is too long.

Delete content property

DELETE /wiki/rest/api/content/{id}/property/{key}

Deletes a content property. For more information about content properties, see Content properties in the REST API.

Permissions required: Permission to update the content.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that the property belongs to.

key REQUIRED

string

The key of the property.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}'

Response

204 No Content

Returned if the content property is deleted.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Get restrictions

GET /wiki/rest/api/content/{id}/restriction

Returns the restrictions on a piece of content.

Permissions required: Permission to view the content.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its restrictions.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content restrictions to expand. By default, the following objects are expanded: restrictions.user, restrictions.group.

  • restrictions.user returns the piece of content that the restrictions are applied to.
  • restrictions.group returns the piece of content that the restrictions are applied to.
  • content returns the piece of content that the restrictions are applied to.

limit

integer

The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.

Default: 100, Minimum: 0

start

integer

The starting index of the users and groups in the returned restrictions.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction'

Response

Returned if the requested restrictions are returned.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Add restrictions

POST /wiki/rest/api/content/{id}/restriction

Adds restrictions to a piece of content. Note, this does not change any existing restrictions on the content.

Permissions required: Permission to edit the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to add restrictions to.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand.

  • restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default.
  • restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default.
  • content returns the piece of content that the restrictions are applied to.

Body parameters

data

[ContentRestrictionUpdate]

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    [
      {
        "operation": "string",
        "restrictions": {
          "group": [
            {
              "name": "string",
              "type": "string"
            }
          ],
          "user": [
            {
              "type": "string",
              "userKey": "string",
              "username": "string"
            }
          ]
        }
      }
    ]' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction'

Response

Returned if the requested restrictions are added.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to add restrictions to the content.

Update restrictions

PUT /wiki/rest/api/content/{id}/restriction

Updates restrictions for a piece of content. This removes the existing restrictions and replaces them with the restrictions in the request.

Permissions required: Permission to edit the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to update restrictions for.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand.

  • restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default.
  • restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default.
  • content returns the piece of content that the restrictions are applied to.

Body parameters

data

[object]

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    [
      {
        "operation": "string",
        "restrictions": {
          "group": [
            {
              "name": "string",
              "type": "string"
            }
          ],
          "user": [
            {
              "type": "string",
              "userKey": "string",
              "username": "string"
            }
          ]
        }
      }
    ]' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction'

Response

Returned if the requested restrictions are updated.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to update restrictions for the content.

Delete restrictions

DELETE /wiki/rest/api/content/{id}/restriction

Removes all restrictions (read and update) on a piece of content.

Permissions required: Permission to edit the content.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to remove restrictions from.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content restrictions (returned in response) to expand.

  • restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default.
  • restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default.
  • content returns the piece of content that the restrictions are applied to.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction'

Response

Returned if the restrictions are removed.

400 Bad Request

Returned if any of the above validation rules are violated

403 Forbidden

Returned if the calling user does not have permission to alter the restrictions on the content.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.

Get restrictions by operation

GET /wiki/rest/api/content/{id}/restriction/byOperation

Returns restrictions on a piece of content by operation. This method is similar to Get restrictions except that the operations are properties of the return object, rather than items in a results array.

Permissions required: Permission to view the content.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its restrictions.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content restrictions to expand.

  • restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default.
  • restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default.
  • content returns the piece of content that the restrictions are applied to.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation'

Response

Returned if the requested restrictions are returned.

Get restrictions for operation

GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}

Returns the restictions on a piece of content for a given operation (read or update).

Permissions required: Permission to view the content.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its restrictions.

operationKey REQUIRED

string

The operation type of the restrictions to be returned.

Valid values:
  • read
  • update

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content restrictions to expand.

  • restrictions.user returns the piece of content that the restrictions are applied to. Expanded by default.
  • restrictions.group returns the piece of content that the restrictions are applied to. Expanded by default.
  • content returns the piece of content that the restrictions are applied to.

limit

integer

The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.

Default: 100, Minimum: 0

start

integer

The starting index of the users and groups in the returned restrictions.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}'

Response

Returned if the requested restrictions are returned.

Get content restriction status for group

GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}

Returns whether the specified content restriction applies to a group. For example, if the ‘admins’ group has permission to read a page with an ID of 123, then the following request will return true:

https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/group/admins

Permissions required: Permission to view the content.

App scope required: READ

Response content type: application/json

Request

Path parameters

groupName REQUIRED

string

The name of the group to be queried for whether the content restriction applies to it.

id REQUIRED

string

The ID of the content that the restriction applies to.

operationKey REQUIRED

string

The operation that the restriction applies to.

Valid values:
  • read
  • update

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'

Response

200 OK

Returns true if the content restriction applies to the group. The response will not return a response body.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.
  • An invalid operation or group is specified.

Add group to content restriction

PUT /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}

Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of content.

Permissions required: Permission to edit the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

groupName REQUIRED

string

The name of the group to add to the content restriction.

id REQUIRED

string

The ID of the content that the restriction applies to.

operationKey REQUIRED

string

The operation that the restriction applies to.

Valid values:
  • read
  • update

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'

Response

200 OK

Returned if the group is added to the content restriction. The response body will be empty.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.
  • An invalid operation or group is specified.

Remove group from content restriction

DELETE /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}

Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.

Permissions required: Permission to edit the content.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

groupName REQUIRED

string

The name of the group to remove from the content restriction.

id REQUIRED

string

The ID of the content that the restriction applies to.

operationKey REQUIRED

string

The operation that the restriction applies to.

Valid values:
  • read
  • update

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}'

Response

200 OK

Returned if the group is removed from the content restriction. The response body will be empty.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.
  • The restriction to be deleted does not exist.

Get content restriction status for user

GET /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user

Returns whether the specified content restriction applies to a user. For example, if the user ‘admin’ has permission to read a page with an ID of 123, then the following request will return true:

https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/user?username=admin

One of key, username, or accountId must be specified as a query parameter to identify the user.

Permissions required: Permission to view the content.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that the restriction applies to.

operationKey REQUIRED

string

The operation that is restricted.

Query parameters

accountId

string

The account ID of the user to be queried for whether the content restriction applies to it.

key

string

The key of the user to be queried for whether the content restriction applies to it.

userName

string

The username of the user to be queried for whether the content restriction applies to it.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'

Response

200 OK

Return true if the content restriction applies to the user. The response body will be empty.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.
  • An invalid operation or user is specified.

Add user to content restriction

PUT /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user

Adds a user to a content restriction. That is, grant read or update permission to the user for a piece of content.

One of key, username, or accountId must be specified as a query parameter to identify the user.

Permissions required: Permission to edit the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that the restriction applies to.

operationKey REQUIRED

string

The operation that the restriction applies to.

Query parameters

accountId

string

The account ID of the user to add to the content restriction.

key

string

The key of the user to add to the content restriction.

userName

string

The username of the user to add to the content restriction.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'

Response

200 OK

Returned if the user is added to the content restriction. The response body will be empty.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.
  • An invalid operation or group is specified.

Remove user from content restriction

DELETE /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user

Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.

Permissions required: Permission to edit the content.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that the restriction applies to.

operationKey REQUIRED

string

The operation that the restriction applies to.

Valid values:
  • read
  • update

Query parameters

accountId

string

The account ID of the user to remove from the content restriction.

key

string

The key of the user to remove from the content restriction.

userName

string

The username of the user to remove from the content restriction.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user'

Response

200 OK

Returned if the user is removed from the content restriction. The response body will be empty.

404 Not Found

Returned if;

  • There is no content with the given ID.
  • The calling user does not have permission to view the content.
  • An invalid operation or group is specified.

Get content versions

GET /wiki/rest/api/content/{id}/version

Returns the versions for a piece of content in descending order.

Permissions required: Permission to view the content. If the content is a blog post, ‘View’ permission for the space is required.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its versions.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content to expand.

  • collaborators returns the users that collaborated on the version.
  • content returns the content for the version.

limit

integer

The maximum number of versions to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0

start

integer

The starting index of the returned versions.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/version'

Response

Returned if the requested versions are returned.

403 Forbidden

Returned if the calling user does not have permission to view the content.

Restore content version

POST /wiki/rest/api/content/{id}/version

Restores a historical version to be the latest version. That is, a new version is created with the content of the historical version.

Permissions required: Permission to update the content.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content for which the history will be restored.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the returned content to expand.

  • collaborators returns the users that collaborated on the version.
  • content returns the content for the version.

Body parameters

operationKey

string

Set to ‘RESTORE’.

Valid values:
  • RESTORE

params REQUIRED

object

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "operationKey": "string",
      "params": {
        "message": "string",
        "versionNumber": 123456
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/version'

Response

Returned if the version is restored.

400 Bad Request

Returned if;

  • There is no content with the given ID.
  • There is no version with the given version number.
  • The version number is the current version.

403 Forbidden

Returned if the calling user doesn’t have permission to edit the content.

Get content version

GET /wiki/rest/api/content/{id}/version/{versionNumber}

Returns a version for a piece of content.

Permissions required: Permission to view the content. If the content is a blog post, ‘View’ permission for the space is required.

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content to be queried for its version.

versionNumber REQUIRED

integer

The number of the version to be retrieved.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the content to expand. By default, the content object is expanded.

  • collaborators returns the users that collaborated on the version.
  • content returns the content for the version.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/version/{versionNumber}'

Response

Returned if the version is returned.

403 Forbidden

Returned if the calling user does not have permission to view the content.

404 Not Found

Returned if the content or version cannot be found.

Delete content version

DELETE /wiki/rest/api/content/{id}/version/{versionNumber}

Delete a historical version. This does not delete the changes made to the content in that version, rather the changes for the deleted version are rolled up into the next version. Note, you cannot delete the current version.

Permissions required: Permission to update the content.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the content that the version will be deleted from.

versionNumber REQUIRED

integer

The number of the version to be deleted. The version number starts from 1 up to current version.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/version/{versionNumber}'

Response

204 No Content

Returned if the version is deleted.

400 Bad Request

Returned if;

  • The content or version cannot be found.
  • The current version is specified.

403 Forbidden

Returned if the calling user doesn’t have permission to edit the content.

Publish legacy draft

POST /wiki/rest/api/content/blueprint/instance/{draftId}

Publishes a legacy draft of a page created from a blueprint. Legacy drafts will eventually be removed in favour of shared drafts. For now, this method works the same as Publish shared draft.

Permissions required: Permission to view the draft and ‘Add’ permission for the space that the content will be created in.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

draftId REQUIRED

string

The ID of the draft page that was created from a blueprint. You can find the draftId in the Confluence application by opening the draft page and checking the page URL.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the new content to expand when returned. By default, the following objects are expanded: body.storage,history,space,version,ancestors

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

status

string

The status of the content to be updated, i.e. the draft. This is set to ‘draft’ by default, so you shouldn’t need to specify it.

Default: draft

Body parameters

ancestors

[object]

The new ancestor (i.e. parent page) for the content. If you have specified an ancestor, you must also specify a space property in the request body for the space that the ancestor is in.

Note, if you specify more than one ancestor, the last ID in the array will be selected as the parent page for the content.

space REQUIRED

object

The space for the content.

status

string

The status of the content. Set this to current or omit it altogether.

Default: current

Valid values:
  • current

title

string

The title of the content. If you don’t want to change the title, set this to the current title of the draft.

Max length: 255

type

string

The type of content. Set this to page.

Valid values:
  • page

version REQUIRED

object

The version for the new content.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "ancestors": [
        {
          "id": "string"
        }
      ],
      "space": {
        "key": "string"
      },
      "status": "string",
      "title": "string",
      "type": "string",
      "version": {
        "number": 123456
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/blueprint/instance/{draftId}'

Response

200 OK schema

Returned if the draft was successfully published.

400 Bad Request

Returned if a title is not specified or a page with the title already exists.

409 Conflict

Returned if the version is not set to 1.

Publish shared draft

PUT /wiki/rest/api/content/blueprint/instance/{draftId}

Publishes a shared draft of a page created from a blueprint.

Permissions required: Permission to view the draft and ‘Add’ permission for the space that the content will be created in.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

draftId REQUIRED

string

The ID of the draft page that was created from a blueprint. You can find the draftId in the Confluence application by opening the draft page and checking the page URL.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the new content to expand when returned. By default, the following objects are expanded: body.storage,history,space,version,ancestors

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

status

string

The status of the content to be updated, i.e. the draft. This is set to ‘draft’ by default, so you shouldn’t need to specify it.

Default: draft

Body parameters

ancestors

[object]

The new ancestor (i.e. parent page) for the content. If you have specified an ancestor, you must also specify a space property in the request body for the space that the ancestor is in.

Note, if you specify more than one ancestor, the last ID in the array will be selected as the parent page for the content.

space REQUIRED

object

The space for the content.

status

string

The status of the content. Set this to current or omit it altogether.

Default: current

Valid values:
  • current

title

string

The title of the content. If you don’t want to change the title, set this to the current title of the draft.

Max length: 255

type

string

The type of content. Set this to page.

Valid values:
  • page

version REQUIRED

object

The version for the new content.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "ancestors": [
        {
          "id": "string"
        }
      ],
      "space": {
        "key": "string"
      },
      "status": "string",
      "title": "string",
      "type": "string",
      "version": {
        "number": 123456
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/blueprint/instance/{draftId}'

Response

200 OK schema

Returned if the draft was successfully published.

400 Bad Request

Returned if a title is not specified or a page with the title already exists.

409 Conflict

Returned if the version is not set to 1.

Search content by CQL

GET /wiki/rest/api/content/search

Returns the list of content that matches a Confluence Query Language (CQL) query. For information on CQL, see: Advanced searching using CQL.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission). Only content that the user has permission to view will be returned.

App scope required: READ

Response content type: application/json

Request

Query parameters

cql

string

The CQL string that is used to find the requested content.

cqlcontext

string

The space, content, and content status to execute the search against. Specify this as an object with the following properties:

  • spaceKey Key of the space to search against. Optional.
  • contentId ID of the content to search against. Optional. Must be in the space spacified by spaceKey.
  • contentStatuses Content statuses to search against. Optional.

expand

[string]

A multi-value parameter indicating which properties of the content to expand.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

limit

integer

The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

start

integer

The starting index of the returned content.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/search'

Response

Returned if the requested list of content is returned.

400 Bad Request

Returned if the CQL is invalid or missing.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

Contentbody

Convert content body

POST /wiki/rest/api/contentbody/convert/{to}

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 required: If request specifies ‘contentIdContext’, ‘View’ permission for the space, and permission to view the content.

App scope required: READ

Response content type: application/json

Request

Path parameters

to REQUIRED

string

The name of the target format for the content body.

Query parameters

contentIdContext

string

The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link <ac:link><ri:page ri:content-title="Example page" /><ac:link> and the contentIdContext=123 parameter is provided, then the link will be converted to a link to the “Example page” page in the same space that has the content with ID=123. Note, spaceKeyContext will be ignored if this parameter is provided.

embeddedContentRender

string

Mode used for rendering embedded content, like attachments.

  • current renders the embedded content using the latest version.
  • version-at-save renders the embedded content using the version at the time of save.

Default: current

Valid values:
  • current
  • version-at-save

expand

[string]

A multi-value parameter indicating which properties of the new content to expand.

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

spaceKeyContext

string

The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link <ac:link><ri:page ri:content-title="Example page" /><ac:link> and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the “Example page” page in the “TEST” space.

Body parameters

representation

string

The content format type. Set the value of this property to the name of the format being used, e.g. ‘storage’.

Valid values:
  • view
  • export_view
  • styled_view
  • storage
  • editor2
  • anonymous_export_view

value

string

The body of the content in the relevant format.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "representation": "string",
      "value": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/contentbody/convert/{to}'

Response

Returned if the content is converted.

Group

Get groups

GET /wiki/rest/api/group

Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Query parameters

limit

integer

The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0

start

integer

The starting index of the returned groups.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group'

Response

Returned if the requested groups are returned.

403 Forbidden

Returned if the calling user does not have permission to view groups.

Get group

GET /wiki/rest/api/group/{groupName}

Returns a user group for a given group name.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Path parameters

groupName REQUIRED

string

The name of the group. This is the same as the group name shown in the Confluence administration console.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/{groupName}'

Response

Returned if the requested group is returned.

403 Forbidden

Returned if the calling user does not have permission to view groups.

Get group members

GET /wiki/rest/api/group/{groupName}/member

Returns the users that are members of a group.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Path parameters

groupName REQUIRED

string

The name of the group to be queried for its members.

Query parameters

limit

integer

The maximum number of users to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0

start

integer

The starting index of the returned users.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/{groupName}/member'

Response

Returned if the requested users are returned.

403 Forbidden

Returned if the calling user does not have permission to view users.

Longtask

Get long-running tasks

GET /wiki/rest/api/longtask

Returns information about all active long-running tasks (e.g. space export), such as how long each task has been running and the percentage of each task that has completed.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Query parameters

limit

integer

The maximum number of tasks to return per page. Note, this may be restricted by fixed system limits.

Default: 100, Minimum: 0

start

integer

The starting index of the returned tasks.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/longtask'

Response

Returned if the requested tasks are returned.

401 Unauthorized

Returned if the calling user is not logged in to Confluence.

Get long-running task

GET /wiki/rest/api/longtask/{id}

Returns information about an active long-running task (e.g. space export), such as how long it has been running and the percentage of the task that has completed.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Path parameters

id REQUIRED

string

The ID of the task.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/longtask/{id}'

Response

Returned if the requested task is returned.

401 Unauthorized

Returned if the calling user is not logged in to Confluence.

404 Not Found

Returned if;

  • There is no task with the given ID.
  • The calling user does not have permission to view the task.

Relation

Find target entities related to a source entity

GET /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}

Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.

For example, the following method finds all content that the current user has an ‘ignore’ relationship with: GET https://your-domain.atlassian.net/wiki/rest/api/relation/ignore/from/user/current/to/content Note, ‘ignore’ is an example custom relationship type.

Permissions required: Permission to view both the target entity and source entity.

App scope required: READ

Response content type: application/json

Request

Path parameters

relationName REQUIRED

string

The name of the relationship. This method supports relationships created via Create relationship. Note, this method does not support ‘favourite’ relationships.

sourceKey REQUIRED

string

  • The identifier for the source entity:

  • If sourceType is ‘user’, then specify either ‘current’ (logged-in user) or the user key.

  • If sourceType is ‘content’, then specify the content ID.

  • If sourceType is ‘space’, then specify the space key.

sourceType REQUIRED

string

The source entity type of the relationship.

Valid values:
  • user
  • content
  • space

targetType REQUIRED

string

The target entity type of the relationship.

Valid values:
  • user
  • content
  • space

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the response object to expand.

  • relationData returns information about the relationship, such as who created it and when it was created.
  • source returns the source entity.
  • target returns the target entity.

limit

integer

The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

sourceStatus

string

The status of the source. This parameter is only used when the sourceType is ‘content’.

sourceVersion

integer

The version of the source. This parameter is only used when the sourceType is ‘content’ and the sourceStatus is ‘historical’.

start

integer

The starting index of the returned relationships.

Default: 0, Minimum: 0

targetStatus

string

The status of the target. This parameter is only used when the targetType is ‘content’.

targetVersion

integer

The version of the target. This parameter is only used when the targetType is ‘content’ and the targetStatus is ‘historical’.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}'

Response

Returned if the requested relationships are returned.

403 Forbidden

Returned if the user does not have permission to view the relationships.

404 Not Found

Returned if the target entity does not exist.

Find relationship from source to target

GET /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}

Find whether a particular type of relationship exists from a source entity to a target entity. Note, relationships are one way.

For example, you can use this method to find whether the current user has selected a particular page as a favorite (i.e. ‘save for later’): GET https://your-domain.atlassian.net/wiki/rest/api/relation/favourite/from/user/current/to/content/123

Permissions required: Permission to view both the target entity and source entity.

App scope required: READ

Response content type: application/json

Request

Path parameters

relationName REQUIRED

string

The name of the relationship. This method supports the ‘favourite’ (i.e. ‘save for later’) relationship as well as any other relationship types created via Create relationship.

sourceKey REQUIRED

string

  • The identifier for the source entity:

  • If sourceType is ‘user’, then specify either ‘current’ (logged-in user) or the user key.

  • If sourceType is ‘content’, then specify the content ID.

  • If sourceType is ‘space’, then specify the space key.

sourceType REQUIRED

string

The source entity type of the relationship. This must be ‘user’, if the relationName is ‘favourite’.

Valid values:
  • user
  • content
  • space

targetKey REQUIRED

string

  • The identifier for the target entity:

  • If sourceType is ‘user’, then specify either ‘current’ (logged-in user) or the user key.

  • If sourceType is ‘content’, then specify the content ID.

  • If sourceType is ‘space’, then specify the space key.

targetType REQUIRED

string

The target entity type of the relationship. This must be ‘space’ or ‘content’, if the relationName is ‘favourite’.

Valid values:
  • user
  • content
  • space

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the response object to expand.

  • relationData returns information about the relationship, such as who created it and when it was created.
  • source returns the source entity.
  • target returns the target entity.

sourceStatus

string

The status of the source. This parameter is only used when the sourceType is ‘content’.

sourceVersion

integer

The version of the source. This parameter is only used when the sourceType is ‘content’ and the sourceStatus is ‘historical’.

targetStatus

string

The status of the target. This parameter is only used when the targetType is ‘content’.

targetVersion

integer

The version of the target. This parameter is only used when the targetType is ‘content’ and the targetStatus is ‘historical’.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}'

Response

Returned if the relationship exists.

403 Forbidden

Returned if the user does not have permission to view the relationship.

404 Not Found

Returned if the relationship does not exist.

Create relationship

PUT /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}

Creates a relationship between two entities (user, space, content). The ‘favourite’ relationship is supported by default, but you can use this method to create any type of relationship between two entities.

For example, the following method creates a ‘sibling’ relationship between two pieces of content: GET https://your-domain.atlassian.net/wiki/rest/api/relation/sibling/from/content/123/to/content/456

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: WRITE

Response content type: application/json

Request

Path parameters

relationName REQUIRED

string

The name of the relationship. This method supports the ‘favourite’ (i.e. ‘save for later’) relationship. You can also specify any other value for this parameter to create a custom relationship type.

sourceKey REQUIRED

string

  • The identifier for the source entity:

  • If sourceType is ‘user’, then specify either ‘current’ (logged-in user) or the user key.

  • If sourceType is ‘content’, then specify the content ID.

  • If sourceType is ‘space’, then specify the space key.

sourceType REQUIRED

string

The source entity type of the relationship. This must be ‘user’, if the relationName is ‘favourite’.

Valid values:
  • user
  • content
  • space

targetKey REQUIRED

string

  • The identifier for the target entity:

  • If sourceType is ‘user’, then specify either ‘current’ (logged-in user) or the user key.

  • If sourceType is ‘content’, then specify the content ID.

  • If sourceType is ‘space’, then specify the space key.

targetType REQUIRED

string

The target entity type of the relationship. This must be ‘space’ or ‘content’, if the relationName is ‘favourite’.

Valid values:
  • user
  • content
  • space

Query parameters

sourceStatus

string

The status of the source. This parameter is only used when the sourceType is ‘content’.

sourceVersion

integer

The version of the source. This parameter is only used when the sourceType is ‘content’ and the sourceStatus is ‘historical’.

targetStatus

string

The status of the target. This parameter is only used when the targetType is ‘content’.

targetVersion

integer

The version of the target. This parameter is only used when the targetType is ‘content’ and the targetStatus is ‘historical’.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}'

Response

Returned if the relationship is created.

403 Forbidden

Returned if the user does not have permission to use Confluence.

404 Not Found

Returned if the user, space or content could not be found.

Delete

DELETE /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}

Deletes a relationship between two entities (user, space, content).

Permissions required: Permission to access the Confluence site (‘Can use’ global permission). For favourite relationships, the current user can only delete their own favourite relationships. A space administrator can delete favourite relationships for any user.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

relationName REQUIRED

string

The name of the relationship.

sourceKey REQUIRED

string

  • The identifier for the source entity:

  • If sourceType is ‘user’, then specify either ‘current’ (logged-in user) or the user key.

  • If sourceType is ‘content’, then specify the content ID.

  • If sourceType is ‘space’, then specify the space key.

sourceType REQUIRED

string

The source entity type of the relationship. This must be ‘user’, if the relationName is ‘favourite’.

Valid values:
  • user
  • content
  • space

targetKey REQUIRED

string

  • The identifier for the target entity:

  • If sourceType is ‘user’, then specify either ‘current’ (logged-in user) or the user key.

  • If sourceType is ‘content’, then specify the content ID.

  • If sourceType is ‘space’, then specify the space key.

targetType REQUIRED

string

The target entity type of the relationship. This must be ‘space’ or ‘content’, if the relationName is ‘favourite’.

Valid values:
  • user
  • content
  • space

Query parameters

sourceStatus

string

The status of the source. This parameter is only used when the sourceType is ‘content’.

sourceVersion

integer

The version of the source. This parameter is only used when the sourceType is ‘content’ and the sourceStatus is ‘historical’.

targetStatus

string

The status of the target. This parameter is only used when the targetType is ‘content’.

targetVersion

integer

The version of the target. This parameter is only used when the targetType is ‘content’ and the targetStatus is ‘historical’.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}'

Response

204 No Content

Returned if the relationship is deleted or the relationship didn’t exist.

403 Forbidden

Returned if the user does not have permission to delete the relationship.

404 Not Found

Returned if the user, space or content could not be found.

Find target entities related to a source entity

GET /wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}

Returns all target entities that have a particular relationship to the source entity. Note, relationships are one way.

For example, the following method finds all users that have a ‘collaborator’ relationship to a piece of content with an ID of ‘1234’: GET https://your-domain.atlassian.net/wiki/rest/api/relation/collaborator/to/content/1234/from/user Note, ‘collaborator’ is an example custom relationship type.

Permissions required: Permission to view both the target entity and source entity.

App scope required: READ

Response content type: application/json

Request

Path parameters

relationName REQUIRED

string

The name of the relationship. This method supports relationships created via Create relationship. Note, this method does not support ‘favourite’ relationships.

sourceType REQUIRED

string

The source entity type of the relationship.

Valid values:
  • user
  • content
  • space

targetKey REQUIRED

string

  • The identifier for the target entity:

  • If sourceType is ‘user’, then specify either ‘current’ (logged-in user) or the user key.

  • If sourceType is ‘content’, then specify the content ID.

  • If sourceType is ‘space’, then specify the space key.

targetType REQUIRED

string

The target entity type of the relationship.

Valid values:
  • user
  • content
  • space

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the response object to expand.

  • relationData returns information about the relationship, such as who created it and when it was created.
  • source returns the source entity.
  • target returns the target entity.

limit

integer

The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

sourceStatus

string

The status of the source. This parameter is only used when the sourceType is ‘content’.

sourceVersion

integer

The version of the source. This parameter is only used when the sourceType is ‘content’ and the sourceStatus is ‘historical’.

start

integer

The starting index of the returned relationships.

Default: 0, Minimum: 0

targetStatus

string

The status of the target. This parameter is only used when the targetType is ‘content’.

targetVersion

integer

The version of the target. This parameter is only used when the targetType is ‘content’ and the targetStatus is ‘historical’.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}'

Response

Returned if the requested relationships are returned.

403 Forbidden

Returned if the user does not have permission to view the relationship

404 Not Found

Returned if the target entity does not exist.

Search

Search

GET /wiki/rest/api/search

Searches for content using the Confluence Query Language (CQL)

Permissions required: Permission to view the entities. Note, only entities that the user has permission to view will be returned.

App scope required: READ

Response content type: application/json

Request

Query parameters

cql REQUIRED

string

The CQL query to be used for the search. See Advanced Searching using CQL for instructions on how to build a CQL query.

cqlcontext

string

The space, content, and content status to execute the search against.

  • spaceKey Key of the space to search against. Optional.
  • contentId ID of the content to search against. Optional. Must be in the space specified by spaceKey.
  • contentStatuses Content statuses to search against. Optional.

Specify these values in an object. For example, cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}

includeArchivedSpaces

boolean

Include content from archived spaces in the results.

Default: false

limit

integer

The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

start

integer

The starting index of the returned content.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/search?cql=string(required)'

Response

Returned if the requested results are returned.

400 Bad Request

Returned if the CQL query cannot be parsed.

403 Forbidden

Returned if the calling user does not have permission to access
Confluence.

Settings

Get look and feel settings

GET /wiki/rest/api/settings/lookandfeel

Returns the look and feel settings for the site or a single space. This includes attributes such as the color scheme, padding, and border radius.

The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme.

Permissions required: None

App scope required: READ

Response content type: application/json

Request

Query parameters

spaceKey

string

The key of the space for which the look and feel settings will be returned. If this is not set, only the global look and feel settings are returned.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel'

Response

Returned if the requested look and feel settings are returned.

400 Bad Request

Returned if spaceKey is invalid.

404 Not Found

Returned if there is no space with the given spaceKey.

Update look and feel settings

POST /wiki/rest/api/settings/lookandfeel/custom

Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created.

Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be overridden.

Permissions required: ‘Admin’ permission for the space.

App scope required: WRITE

Response content type: application/json

Request

Query parameters

spaceKey

string

The key of the space for which the look and feel settings will be updated. If this is not set, the global look and feel settings will be updated.

Body parameters

bordersAndDividers REQUIRED

object

content

ContentLookAndFeel

header

HeaderLookAndFeel

headings REQUIRED

object

object

menus

MenusLookAndFeel

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "bordersAndDividers": {
        "color": "string"
      },
      "content": {
        "body": {},
        "container": {
          "background": "string",
          "backgroundColor": "string",
          "backgroundImage": "string",
          "backgroundSize": "string",
          "borderRadius": "string",
          "padding": "string"
        },
        "header": {},
        "screen": {
          "background": "string",
          "backgroundColor": "string",
          "backgroundImage": "string",
          "backgroundSize": "string",
          "gutterBottom": "string",
          "gutterLeft": "string",
          "gutterRight": "string",
          "gutterTop": "string"
        }
      },
      "header": {
        "backgroundColor": "string",
        "button": {
          "backgroundColor": "string",
          "color": "string"
        },
        "primaryNavigation": {
          "color": "string",
          "hoverOrFocus": {
            "backgroundColor": "string",
            "color": "string"
          }
        },
        "search": {
          "backgroundColor": "string",
          "color": "string"
        },
        "secondaryNavigation": {}
      },
      "headings": {
        "color": "string"
      },
      "links": {
        "color": "string"
      },
      "menus": {
        "color": "string",
        "hoverOrFocus": {
          "backgroundColor": "string"
        }
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/custom'

Response

Returned if the look and feel settings are updated.

400 Bad Request

Returned if;

  • The spaceKey is invalid
  • The request body contains invalid data.

403 Forbidden

Returned if the calling user doesn’t have permission to edit the look and feel settings.

404 Not Found

Returned if there is no space with the given spaceKey.

Reset look and feel settings

DELETE /wiki/rest/api/settings/lookandfeel/custom

Resets the custom look and feel settings for the site or a single space. This changes the values of the custom settings to be the same as the default settings. It does not change which settings (default or custom) are selected. Note, the default space settings are inherited from the current global settings.

Permissions required: ‘Admin’ permission for the space.

App scope required: DELETE

Response content type: application/json

Request

Query parameters

spaceKey

string

The key of the space for which the look and feel settings will be reset. If this is not set, the global look and feel settings will be reset.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/custom'

Response

204 No Content

Returned if the look and feel settings have been reset.

400 Bad Request

Returned if spaceKey is invalid.

403 Forbidden

Returned if the calling user doesn’t have permission to reset the look and feel.

404 Not Found

Returned if there is no space with the given spaceKey.

Set look and feel settings

PUT /wiki/rest/api/settings/lookandfeel/selected

Sets the look and feel settings to either the default settings or the custom settings, for the site or a single space. Note, the default space settings are inherited from the current global settings.

Permissions required: ‘Admin’ permission for the space.

App scope required: WRITE

Response content type: application/json

Request

Query parameters

spaceKey

string

The key of the space for which the look and feel settings will be set. If this is not set, the global look and feel settings will be set.

Body parameters

custom

LookAndFeel

global

LookAndFeel

selected

string

The look and feel scheme. If you set this to global, you must specify the current global look and feel settings as a global object in this request. Similarly, if you set this to custom, you must specify the current custom look and feel settings as a custom object in this request.

Valid values:
  • global
  • custom

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "custom": {},
      "global": {
        "bordersAndDividers": {
          "color": "string"
        },
        "content": {
          "body": {},
          "container": {
            "background": "string",
            "backgroundColor": "string",
            "backgroundImage": "string",
            "backgroundSize": "string",
            "borderRadius": "string",
            "padding": "string"
          },
          "header": {},
          "screen": {
            "background": "string",
            "backgroundColor": "string",
            "backgroundImage": "string",
            "backgroundSize": "string",
            "gutterBottom": "string",
            "gutterLeft": "string",
            "gutterRight": "string",
            "gutterTop": "string"
          }
        },
        "header": {
          "backgroundColor": "string",
          "button": {
            "backgroundColor": "string",
            "color": "string"
          },
          "primaryNavigation": {
            "color": "string",
            "hoverOrFocus": {
              "backgroundColor": "string",
              "color": "string"
            }
          },
          "search": {
            "backgroundColor": "string",
            "color": "string"
          },
          "secondaryNavigation": {}
        },
        "headings": {
          "color": "string"
        },
        "links": {
          "color": "string"
        },
        "menus": {
          "color": "string",
          "hoverOrFocus": {
            "backgroundColor": "string"
          }
        }
      },
      "selected": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/lookandfeel/selected'

Response

Returned if the look and feel settings were set.

400 Bad Request

Returned if;

  • The spaceKey is invalid.
  • The look and feel type is invalid.

403 Forbidden

Returned if the look and feel type is set to ‘theme’ but the space/site doesn’t have a theme assigned.

404 Not Found

Returned if there is no space with the given spaceKey.

Get system info

GET /wiki/rest/api/settings/systemInfo

Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

There are no parameters for this request.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/systemInfo'

Response

Returned if the system information for the Confluence Cloud tenant is returned.

403 Forbidden

Returned when the user does not have permission to view the system information.

Get themes

GET /wiki/rest/api/settings/theme

Returns all themes, not including the default theme.

Permissions required: None

App scope required: READ

Response content type: application/json

Request

Query parameters

limit

integer

The maximum number of themes to return per page. Note, this may be restricted by fixed system limits.

Default: 100, Minimum: 0

start

integer

The starting index of the returned themes.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/theme'

Response

Returned if the requested themes are returned.

Get theme

GET /wiki/rest/api/settings/theme/{themeKey}

Returns a theme. This includes information about the theme name, description, and icon.

Permissions required: None

App scope required: READ

Response content type: application/json

Request

Path parameters

themeKey REQUIRED

string

The key of the theme to be returned.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/theme/{themeKey}'

Response

Returned if the requested theme is returned.

404 Not Found

Returned if there is no theme with the given key.

Get global theme

GET /wiki/rest/api/settings/theme/selected

Returns the globally assigned theme.

Permissions required: None

App scope required: READ

Response content type: application/json

Request

There are no parameters for this request.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/theme/selected'

Response

Returned if the global theme is returned.

404 Not Found

Returned if Confluence does not have a global theme assigned, i.e. the default theme is used.

Space

Get spaces

GET /wiki/rest/api/space

Returns all spaces. The returned spaces are ordered alphabetically in ascending order by space key.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission). Note, the returned list will only contain spaces that the current user has permission to view.

App scope required: READ

Response content type: application/json

Request

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the spaces to expand, where:

  • settings returns the settings for the space, similar to Get space settings.
  • metadata.labels returns the space labels, which are used to categorize the space.
  • operations returns the operations for a space, which are used when setting permissions.
  • lookAndFeel returns information about the look and feel of the space, like the color scheme.
  • permissions returns the permissions for the space.
  • icon returns information about space icon.
  • description.plain returns the description of the space.
  • description.view returns the description of the space.
  • theme returns information about the space theme.
  • homepage returns information about the space homepage.

favourite

boolean

Filter the results to the favourite spaces of the user specified by favouriteUserKey. Note, ‘favourite’ spaces are also known as ‘saved for later’ spaces.

favouriteUserKey

string

The userKey of the user, whose favourite spaces are used to filter the results when using the favourite parameter.

Leave blank for the current user. Use Get user to get the userKey for a user.

label

[string]

Filter the results to spaces based on their label.

limit

integer

The maximum number of spaces to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

spaceKey

[string]

The key of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.

start

integer

The starting index of the returned spaces.

Default: 0, Minimum: 0

status

string

Filter the results to spaces based on their status.

Valid values:
  • current
  • archived

type

string

Filter the results to spaces based on their type.

Valid values:
  • global
  • personal

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space'

Response

Returned if the requested spaces are returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

Create space

POST /wiki/rest/api/space

Creates a new space. Note, currently you cannot set space labels when creating a space.

Permissions required: ‘Create Space(s)’ global permission.

App scope required: WRITE

Response content type: application/json

Request

Body parameters

description

SpaceDescriptionCreate

key

string

The key for the new space. Format: See Space keys.

name

string

The name of the new space.

Max length: 200

permissions

[SpacePermission]

The permissions for the new space. If no permissions are provided, the Confluence default space permissions are applied. Note, for security reasons, permissions cannot be changed via the API after the space has been created, and must be changed via the user interface instead.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "description": {
        "plain": {
          "representation": "string",
          "value": "string"
        }
      },
      "key": "string",
      "name": "string",
      "permissions": [
        {
          "anonymousAccess": true,
          "operation": {},
          "subjects": {
            "_expandable": {
              "group": "string",
              "user": "string"
            },
            "group": {
              "results": [
                {}
              ],
              "size": 123456
            },
            "user": {
              "results": [
                {
                  "_expandable": {
                    "details": "string",
                    "operations": "string",
                    "personalSpace": "string"
                  },
                  "_links": {},
                  "accountId": "string",
                  "details": {
                    "business": {
                      "department": "string",
                      "location": "string",
                      "position": "string"
                    },
                    "personal": {
                      "email": "string",
                      "im": "string",
                      "phone": "string",
                      "website": "string"
                    }
                  },
                  "displayName": "string",
                  "operations": [
                    {
                      "operation": "string",
                      "targetType": "string"
                    }
                  ],
                  "personalSpace": {
                    "_expandable": {
                      "description": "string",
                      "history": "string",
                      "homepage": "string",
                      "icon": "string",
                      "lookAndFeel": "string",
                      "metadata": "string",
                      "operations": "string",
                      "permissions": "string",
                      "settings": "string",
                      "theme": "string"
                    },
                    "_links": {},
                    "description": {
                      "plain": {
                        "embeddedContent": [
                          {}
                        ],
                        "representation": "string",
                        "value": "string"
                      },
                      "view": {}
                    },
                    "history": {
                      "createdDate": "string"
                    },
                    "homepage": {
                      "_expandable": {
                        "ancestors": "string",
                        "body": "string",
                        "childTypes": "string",
                        "children": "string",
                        "container": "string",
                        "descendants": "string",
                        "history": "string",
                        "metadata": "string",
                        "operations": "string",
                        "restrictions": "string",
                        "space": "string",
                        "version": "string"
                      },
                      "_links": {},
                      "ancestors": [
                        {}
                      ],
                      "body": {
                        "_expandable": {
                          "anonymous_export_view": "string",
                          "editor": "string",
                          "editor2": "string",
                          "export_view": "string",
                          "storage": "string",
                          "styled_view": "string",
                          "view": "string"
                        },
                        "anonymous_export_view": {},
                        "editor2": {},
                        "export_view": {},
                        "storage": {},
                        "styled_view": {},
                        "view": {
                          "_expandable": {
                            "content": "string"
                          },
                          "embeddedContent": [
                            {
                              "entity": {},
                              "entityId": 123456
                            }
                          ],
                          "representation": "string",
                          "value": "string",
                          "webresource": {
                            "contexts": [
                              "string"
                            ],
                            "keys": [
                              "string"
                            ],
                            "superbatch": {
                              "metatags": "string",
                              "tags": {
                                "all": "string",
                                "css": "string",
                                "data": "string",
                                "js": "string"
                              },
                              "uris": {
                                "all": "string",
                                "css": "string",
                                "js": "string"
                              }
                            },
                            "tags": {
                              "all": "string",
                              "css": "string",
                              "data": "string",
                              "js": "string"
                            },
                            "uris": {
                              "all": "string",
                              "css": "string",
                              "js": "string"
                            }
                          }
                        }
                      },
                      "childTypes": {
                        "_expandable": {
                          "all": "string",
                          "attachment": "string",
                          "comment": "string",
                          "page": "string"
                        },
                        "attachment": {
                          "_links": {},
                          "value": true
                        },
                        "comment": {
                          "_links": {},
                          "value": true
                        },
                        "page": {
                          "_links": {},
                          "value": true
                        }
                      },
                      "children": {
                        "_expandable": {
                          "attachment": "string",
                          "comment": "string",
                          "page": "string"
                        },
                        "_links": {},
                        "attachment": {
                          "_links": {},
                          "limit": 123456,
                          "results": [
                            {}
                          ],
                          "size": 123456,
                          "start": 123456
                        },
                        "comment": {},
                        "page": {}
                      },
                      "container": {},
                      "descendants": {},
                      "history": {
                        "_expandable": {
                          "contributors": "string",
                          "lastUpdated": "string",
                          "nextVersion": "string",
                          "previousVersion": "string"
                        },
                        "_links": {},
                        "contributors": {
                          "publishers": {}
                        },
                        "createdBy": {},
                        "createdDate": "string",
                        "lastUpdated": {
                          "_expandable": {
                            "collaborators": "string",
                            "content": "string"
                          },
                          "_links": {},
                          "by": {},
                          "collaborators": {
                            "_links": {},
                            "userKeys": [
                              "string"
                            ],
                            "users": [
                              {}
                            ]
                          },
                          "content": {},
                          "friendlyWhen": "string",
                          "message": "string",
                          "minorEdit": true,
                          "number": 123456,
                          "when": "string"
                        },
                        "latest": true,
                        "nextVersion": {},
                        "previousVersion": {}
                      },
                      "id": "string",
                      "operations": [
                        {}
                      ],
                      "restrictions": {
                        "_links": {},
                        "read": {
                          "_expandable": {
                            "content": "string",
                            "restrictions": "string"
                          },
                          "_links": {},
                          "content": {},
                          "operation": "string",
                          "restrictions": {
                            "_expandable": {
                              "group": "string",
                              "user": "string"
                            },
                            "group": {
                              "limit": 123456,
                              "results": [
                                {
                                  "_links": {},
                                  "name": "string",
                                  "type": "string"
                                }
                              ],
                              "size": 123456,
                              "start": 123456
                            },
                            "user": {
                              "limit": 123456,
                              "results": [
                                {}
                              ],
                              "size": 123456,
                              "start": 123456
                            }
                          }
                        },
                        "update": {}
                      },
                      "space": {},
                      "status": "string",
                      "title": "string",
                      "type": "string",
                      "version": {}
                    },
                    "icon": {},
                    "id": 123456,
                    "key": "string",
                    "lookAndFeel": {
                      "bordersAndDividers": {
                        "color": "string"
                      },
                      "content": {
                        "body": {},
                        "container": {
                          "background": "string",
                          "backgroundColor": "string",
                          "backgroundImage": "string",
                          "backgroundSize": "string",
                          "borderRadius": "string",
                          "padding": "string"
                        },
                        "header": {},
                        "screen": {
                          "background": "string",
                          "backgroundColor": "string",
                          "backgroundImage": "string",
                          "backgroundSize": "string",
                          "gutterBottom": "string",
                          "gutterLeft": "string",
                          "gutterRight": "string",
                          "gutterTop": "string"
                        }
                      },
                      "header": {
                        "backgroundColor": "string",
                        "button": {
                          "backgroundColor": "string",
                          "color": "string"
                        },
                        "primaryNavigation": {
                          "color": "string",
                          "hoverOrFocus": {
                            "backgroundColor": "string",
                            "color": "string"
                          }
                        },
                        "search": {
                          "backgroundColor": "string",
                          "color": "string"
                        },
                        "secondaryNavigation": {}
                      },
                      "headings": {
                        "color": "string"
                      },
                      "links": {
                        "color": "string"
                      },
                      "menus": {
                        "color": "string",
                        "hoverOrFocus": {
                          "backgroundColor": "string"
                        }
                      }
                    },
                    "metadata": {
                      "labels": {
                        "_links": {},
                        "limit": 123456,
                        "results": [
                          {
                            "id": "string",
                            "label": "string",
                            "name": "string",
                            "prefix": "string"
                          }
                        ],
                        "size": 123456,
                        "start": 123456
                      }
                    },
                    "name": "string",
                    "operations": [
                      {}
                    ],
                    "permissions": [
                      {}
                    ],
                    "settings": {
                      "_links": {},
                      "routeOverrideEnabled": true
                    },
                    "status": "string",
                    "theme": "unknown",
                    "type": "string"
                  },
                  "profilePicture": {
                    "height": 123456,
                    "isDefault": true,
                    "path": "string",
                    "width": 123456
                  },
                  "type": "string",
                  "userKey": "string",
                  "username": "string"
                }
              ],
              "size": 123456
            }
          },
          "unlicensedAccess": true
        }
      ]
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space'

Response

Returned if the space is created.

400 Bad Request

Returned if any of the following is true:

  • The request is invalid.
  • The space already exists.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

403 Forbidden

Returned if the callig user does not have permission to create a space.

Create private space

POST /wiki/rest/api/space/_private

Creates a new space that is only visible to the creator. This method is the same as the Create space method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space.

Permissions required: ‘Create Space(s)’ global permission.

App scope required: WRITE

Response content type: application/json

Request

Body parameters

description

SpaceDescriptionCreate

key

string

The key for the new space. Format: See Space keys.

name

string

The name of the new space.

Max length: 200

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "description": {
        "plain": {
          "representation": "string",
          "value": "string"
        }
      },
      "key": "string",
      "name": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/_private'

Response

Returned if the space is created.

400 Bad Request

Returned if any of the following is true:

  • The request is invalid.
  • The space already exists.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

403 Forbidden

Returned if the user does not have permission to create a space.

Get space

GET /wiki/rest/api/space/{spaceKey}

Returns a space. This includes information like the name, description, and permissions, but not the content in the space.

Permissions required: ‘View’ permission for the space.

App scope required: READ

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to be returned.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the space to expand, where:

  • settings returns the settings for the space, similar to Get space settings.
  • metadata.labels returns the space labels, which are used to categorize the space.
  • operations returns the operations for a space, which are used when setting permissions.
  • lookAndFeel returns information about the look and feel of the space, like the color scheme.
  • permissions returns the permissions for the space.
  • icon returns information about space icon.
  • description.plain returns the description of the space.
  • description.view returns the description of the space.
  • theme returns information about the space theme.
  • homepage returns information about the space homepage.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}'

Response

Returned if the requested space is returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given key.
  • The calling user does not have permission to view the space.

Update space

PUT /wiki/rest/api/space/{spaceKey}

Updates the name, description, or homepage of a space.

  • For security reasons, permissions cannot be updated via the API and must be changed via the user interface instead.
  • Currently you cannot set space labels when updating a space.

Permissions required: ‘Admin’ permission for the space.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to update.

Body parameters

description

SpaceDescriptionCreate

homepage REQUIRED

object

The page to set as the homepage of the space.

name

string

The name of the space.

Max length: 200

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "description": {
        "plain": {
          "representation": "string",
          "value": "string"
        }
      },
      "homepage": {
        "id": "string"
      },
      "name": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}'

Response

Returned if the space is updated.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given key
  • The calling user does not have permission to update the space.

Delete space

DELETE /wiki/rest/api/space/{spaceKey}

Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status link that is returned in the response until the task completes.

Permissions required: ‘Admin’ permission for the space.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to delete.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}'

Response

202 Accepted

Returns a pointer to the status of the space deletion task.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given key.
  • The calling user does not have permission to delete the space.

Get content for space

GET /wiki/rest/api/space/{spaceKey}/content

Returns all content in a space. The returned content is grouped by type (pages then blogposts), then ordered by content ID in ascending order.

Permissions required: ‘View’ permission for the space. Note, the returned list will only contain content that the current user has permission to view.

App scope required: READ

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to be queried for its content.

Query parameters

depth

string

Filter the results to content at the root level of the space or all content.

Default: all

Valid values:
  • all
  • root

expand

[string]

A multi-value parameter indicating which properties of the content to expand, where:

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

limit

integer

The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

start

integer

The starting index of the returned content.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/content'

Response

Returned if the requested content is returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given key.
  • The calling user does not have permission to view the space.

Get content by type for space

GET /wiki/rest/api/space/{spaceKey}/content/{type}

Returns all content of a given type, in a space. The returned content is ordered by content ID in ascending order.

Permissions required: ‘View’ permission for the space. Note, the returned list will only contain content that the current user has permission to view.

App scope required: READ

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to be queried for its content.

type REQUIRED

string

The type of content to return.

Valid values:
  • page
  • blogpost

Query parameters

depth

string

Filter the results to content at the root level of the space or all content.

Default: all

Valid values:
  • all
  • root

expand

[string]

A multi-value parameter indicating which properties of the content to expand, where:

  • childTypes.all returns whether the content has attachments, comments, or child pages. Use this if you only need to check whether the content has children of a particular type.
  • childTypes.attachment returns whether the content has attachments.
  • childTypes.comment returns whether the content has comments.
  • childTypes.page returns whether the content has child pages.
  • container returns the space that the content is in. This is the same as the information returned by Get space.
  • metadata.currentuser returns information about the current user in relation to the content, like when they last viewed it, modified it, contributed to it, or added it as a favourite.
  • metadata.properties returns content properties that have been set via the Confluence REST API.
  • metadata.labels returns the labels that have been added to the content.
  • metadata.frontend (this property is only used by Atlassian)
  • operations returns the operations for the content, which are used when setting permissions.
  • children.page returns pages that are descendants at the level immediately below the content.
  • children.attachment returns all attachments for the content.
  • children.comment returns all comments on the content.
  • restrictions.read.restrictions.user returns the users that have permission to read the content.
  • restrictions.read.restrictions.group returns the groups that have permission to read the content.
  • restrictions.update.restrictions.user returns the users that have permission to update the content.
  • restrictions.update.restrictions.group returns the groups that have permission to update the content.
  • history returns the history of the content, including the date it was created.
  • history.lastUpdated returns information about the most recent update of the content, including who updated it and when it was updated.
  • history.previousVersion returns information about the update prior to the current content update.
  • history.contributors returns all of the users who have contributed to the content.
  • history.nextVersion returns information about the update after to the current content update.
  • ancestors returns the parent page, if the content is a page.
  • body returns the body of the content in different formats, including the editor format, view format, and export format.
  • version returns information about the most recent update of the content, including who updated it and when it was updated.
  • descendants.page returns pages that are descendants at any level below the content.
  • descendants.attachment returns all attachments for the content, same as children.attachment.
  • descendants.comment returns all comments on the content, same as children.comment.
  • space returns the space that the content is in. This is the same as the information returned by Get space.

limit

integer

The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

start

integer

The starting index of the returned content.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/content/{type}'

Response

Returned if the requested content is returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given key.
  • The calling user does not have permission to view the space.

Get space properties

GET /wiki/rest/api/space/{spaceKey}/property

Returns all properties for the given space. Space properties are a key-value storage associated with a space.

Permissions required: ‘View’ permission for the space.

App scope required: READ

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to be queried for its properties.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the space property to expand. By default, the version object is expanded.

  • version returns information about the version of the content.
  • space returns the space that the properties are in.

limit

integer

The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.

Default: 10, Minimum: 0

start

integer

The starting index of the returned objects.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property'

Response

Returned if the requested space properties are returned.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given key.
  • The calling user does not have permission to view the space.

Create space property

POST /wiki/rest/api/space/{spaceKey}/property

Creates a new space property.

Permissions required: ‘Admin’ permission for the space.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space that the property will be created in.

Body parameters

key

string

The key of the new property.

Maximum: 255

value

PropertyValue

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "key": "string",
      "value": {}
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property'

Response

Returned if the space property is created.

400 Bad Request

Returned if any of the following is true:

  • The space already has a value with the given key.
  • No property value was provided.

403 Forbidden

Returned if the user does not have ‘Admin’ permission for the space.

413 Request Entity Too Large

Returned if the value for the property is too long.

Get space property

GET /wiki/rest/api/space/{spaceKey}/property/{key}

Returns a space property.

Permissions required: ‘View’ permission for the space.

App scope required: READ

Response content type: application/json

Request

Path parameters

key REQUIRED

string

The key of the space property.

spaceKey REQUIRED

string

The key of the space that the property is in.

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the space property to expand. By default, the version object is expanded.

  • version returns information about the version of the content.
  • space returns the space that the properties are in.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}'

Response

Returned if the requested space property is returned.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given key.
  • There is no property with the given key.
  • The calling user does not have permission to view the space.

Create space property for key

POST /wiki/rest/api/space/{spaceKey}/property/{key}

Creates a new space property. This is the same as POST /space/{spaceKey}/property but the key for the property is passed as a path parameter, rather than in the request body.

Permissions required: ‘Admin’ permission for the space.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

key REQUIRED

string

The key of the property to be created.

spaceKey REQUIRED

string

The key of the space that the property will be created in.

Body parameters

value

PropertyValue

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "value": {}
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}'

Response

Returned if the space property is created.

400 Bad Request

Returned if any of the following is true:

  • The space already has a value with the given key.
  • No property value was provided.

403 Forbidden

Returned if the user does not have the ‘Admin’ permission for the space.

413 Request Entity Too Large

Returned if the value for the property is too long.

Update space property

PUT /wiki/rest/api/space/{spaceKey}/property/{key}

Updates a space property. Note, you cannot update the key of a space property, only the value.

Permissions required: ‘Admin’ permission for the space.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

key REQUIRED

string

The key of the property to be updated.

spaceKey REQUIRED

string

The key of the space that the property is in.

Body parameters

value

object

The value of the property.

version REQUIRED

object

The version number of the property.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "value": {},
      "version": {
        "minorEdit": true,
        "number": 123456
      }
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}'

Response

Returned if the space property is updated.

400 Bad Request

Returned if any of the following is true:

  • The given property has a different spaceKey to the one in the path.
  • The property has a different key to the one in the path.

403 Forbidden

Returned if the user does not have permission to edit the space with the given spaceKey

404 Not Found

Returned if any of the following is true:

  • There is no space with the given spaceKey
  • There is no property with the given key.
  • The calling user does not have permission to view the space.

409 Conflict

Returned if the given version is does not match the expected target version of the updated property

413 Request Entity Too Large

Returned if the value of the property is too long.

Delete space property

DELETE /wiki/rest/api/space/{spaceKey}/property/{key}

Deletes a space property.

Permissions required: ‘Admin’ permission for the space.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

key REQUIRED

string

The key of the property to be deleted.

spaceKey REQUIRED

string

The key of the space that the property is in.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}'

Response

204 No Content

Returned if the space property is deleted.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given spaceKey
  • There is no property with the given key.
  • The calling user does not have permission to view the space.

Get space settings

GET /wiki/rest/api/space/{spaceKey}/settings

Returns the settings of a space. Currently only the routeOverrideEnabled setting can be returned.

Permissions required: ‘View’ permission for the space.

App scope required: READ

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to be queried for its settings.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/settings'

Response

Returned if the space settings are returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if;

  • There is no space with the given key.
  • The calling user does not have permission to view the space.

Update space settings

PUT /wiki/rest/api/space/{spaceKey}/settings

Updates the settings for a space. Currently only the routeOverrideEnabled setting can be updated.

Permissions required: ‘Admin’ permission for the space.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space whose settings will be updated.

Body parameters

routeOverrideEnabled

boolean

Defines whether an override for the space home should be used. This is used in conjunction with a space theme provided by an app. For example, if this property is set to true, a theme can display a page other than the space homepage when users visit the root URL for a space. This property allows apps to provide content-only theming without overriding the space home.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "routeOverrideEnabled": true
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/settings'

Response

Returned if space settings are updated.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

404 Not Found

Returned if;

  • There is no space with the given key.
  • The calling user does not have permission to update the space.

Get space theme

GET /wiki/rest/api/space/{spaceKey}/theme

Returns the theme selected for a space, if one is set. If no space theme is set, this means that the space is inheriting the global look and feel settings.

Permissions required: ‘View’ permission for the space.

App scope required: READ

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to be queried for its theme.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/theme'

Response

Returned if the requested theme is returned.

404 Not Found

Returned if any of the following is true:

  • There is no space with the given key.
  • The space does not have a theme assigned to it.

Set space theme

PUT /wiki/rest/api/space/{spaceKey}/theme

Sets the theme for a space. Note, if you want to reset the space theme to the default Confluence theme, use the ‘Reset space theme’ method instead of this method.

Permissions required: ‘Admin’ permission for the space.

App scope required: WRITE

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to set the theme for.

Body parameters

themeKey

string

The key of the theme to be set as the space theme.

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "themeKey": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/theme'

Response

Returned if the theme was set for the space.

403 Forbidden

Returned if the theme key is invalid.

404 Not Found

Returned if there is no space with the given key.

Reset space theme

DELETE /wiki/rest/api/space/{spaceKey}/theme

Resets the space theme. This means that the space will inherit the global look and feel settings

Permissions required: ‘Admin’ permission for the space.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to reset the theme for.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/theme'

Response

204 No Content

Returned if the theme was reset for the space.

404 Not Found

Returned if there is no space with the given key.

Template

Create content template

POST /wiki/rest/api/template

Creates a new content template. Note, blueprint templates cannot be created via the REST API.

Permissions required: ‘Admin’ permission for the space to create a space template or ‘Confluence Administrator’ global permission to create a global template.

App scope required: WRITE

Response content type: application/json

Request

Body parameters

body

ContentBodyCreate

description

string

A description of the new template.

Max length: 255

labels

[Label]

Labels for the new template.

name

string

The name of the new template.

space REQUIRED

object

The key for the space of the new template. Only applies to space templates. If the spaceKey is not specified, the template will be created as a global template.

templateType

string

The type of the new template. Set to page.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "body": {
        "representation": "string",
        "value": "string"
      },
      "description": "string",
      "labels": [
        {
          "id": "string",
          "label": "string",
          "name": "string",
          "prefix": "string"
        }
      ],
      "name": "string",
      "space": {
        "key": "string"
      },
      "templateType": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/template'

Response

Returned if the template is created.

403 Forbidden

Returned if the calling user does not have permission to create the template.

Update content template

PUT /wiki/rest/api/template

Updates a content template. Note, blueprint templates cannot be updated via the REST API.

Permissions required: ‘Admin’ permission for the space to create a space template or ‘Confluence Administrator’ global permission to create a global template.

App scope required: WRITE

Response content type: application/json

Request

Body parameters

body

ContentBodyCreate

description

string

A description of the template.

Max length: 100

labels

[Label]

Labels for the template.

name

string

The name of the template. Set to the current name if this field is not being updated.

space REQUIRED

object

The key for the space of the template. Required if the template is a space template. Set this to the current space.key.

templateId

string

The ID of the template being updated.

templateType

string

The type of the template. Set to page.

Valid values:
  • page

Example

curl --request PUT \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '
    {
      "body": {
        "representation": "string",
        "value": "string"
      },
      "description": "string",
      "labels": [
        {
          "id": "string",
          "label": "string",
          "name": "string",
          "prefix": "string"
        }
      ],
      "name": "string",
      "space": {
        "key": "string"
      },
      "templateId": "string",
      "templateType": "string"
    }' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/template'

Response

Returned if the template is updated.

403 Forbidden

Returned if the calling user does not have permission to update the template.

Get content template

GET /wiki/rest/api/template/{contentTemplateId}

Returns a content template. This includes information about template, like the name, the space or blueprint that the template is in, the body of the template, and more.

Permissions required: ‘Admin’ permission for the space to view space templates and ‘Confluence Administrator’ global permission to view global templates.

App scope required: READ

Response content type: application/json

Request

Path parameters

contentTemplateId REQUIRED

string

The ID of the content template to be returned.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/template/{contentTemplateId}'

Response

Returned if the requested template is returned.

403 Forbidden

Returned if;

  • There is no template with the given ID.
  • The calling user does not have permission to view the template.

Remove template

DELETE /wiki/rest/api/template/{contentTemplateId}

Deletes a template. This results in different actions depending on the type of template:

  • If the template is a content template, it is deleted.
  • If the template is a modified space-level blueprint template, it reverts to the template inherited from the global-level blueprint template.
  • If the template is a modified global-level blueprint template, it reverts to the default global-level blueprint template.

Note, unmodified blueprint templates cannot be deleted.

App scope required: DELETE

Response content type: application/json

Request

Path parameters

contentTemplateId REQUIRED

string

The ID of the template to be deleted.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/template/{contentTemplateId}'

Response

204 No Content

Returned if the template has been successfully been deleted.

Get blueprint templates

GET /wiki/rest/api/template/blueprint

Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space.

Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the global blueprints.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the template to expand.

  • body returns the content of the template in storage format.

limit

integer

The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

spaceKey

string

The key of the space to be queried for templates. If the spaceKey is not specified, global blueprint templates will be returned.

start

integer

The starting index of the returned templates.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/template/blueprint'

Response

Returned if the requested templates are returned.

403 Forbidden

Returned if the calling user does not have permission to view blueprint templates.

Get content templates

GET /wiki/rest/api/template/page

Returns all content templates. Use this method to retrieve all global content templates or all content templates in a space.

Permissions required: ‘Admin’ permission for the space to view space templates and ‘Confluence Administrator’ global permission to view global templates.

App scope required: READ

Response content type: application/json

Request

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the template to expand.

  • body returns the content of the template in storage format.

limit

integer

The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0

spaceKey

string

The key of the space to be queried for templates. If the spaceKey is not specified, global templates will be returned.

start

integer

The starting index of the returned templates.

Default: 0, Minimum: 0

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/template/page'

Response

Returned if the requested templates are returned.

403 Forbidden

Returned if the calling user does not have permission to view the content templates.

User

Get user

GET /wiki/rest/api/user

Returns a user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more.

The username, key, or accountId parameter must be specified, in order to identify the user.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Query parameters

accountId

string

The accountId of the user to be returned. Required, unless the username or key is specified. The accountId uniquely identifies a user across all Atlassian products.

expand

[string]

A multi-value parameter indicating which properties of the user to expand.

  • operations returns the operations that the user is allowed to do.
  • details.personal returns the ‘Personal’ details in the user’s profile, like the ‘Email’ and ‘Phone’.
  • details.business returns the ‘Company’ details in the user’s profile, like the ‘Position’ and ‘Department’.
  • personalSpace returns the user’s personal space, if it exists.

key

string

The userKey of the user to be returned. Required, unless the username or accountId is specified. The key uniquely identifies a user in a Confluence instance and does not change.

username

string

The username of the user to be returned. Required, unless the key or accountId is specified. The username uniquely identifies a user in a Confluence instance but can change if the user is renamed.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user'

Response

Returned if the requested user is returned.

401 Unauthorized

Returned if the authentication credentials are incorrect or missing from the request.

403 Forbidden

Returned if the calling user does not have permission to view users.

404 Not Found

Returned if a user with the given username, userkey, or accountId does not exist.

Get anonymous user

GET /wiki/rest/api/user/anonymous

Returns information about how anonymous users are represented, like the profile picture and display name.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the user to expand.

  • operations returns the operations that the user is allowed to do.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/anonymous'

Response

Returned if the anonymous user representation is returned.

403 Forbidden

Returned if the calling user does not have permission to use Confluence.

Get current user

GET /wiki/rest/api/user/current

Returns the currently logged-in user. This includes information about the user, like the display name, userKey, account ID, profile picture, and more.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Query parameters

expand

[string]

A multi-value parameter indicating which properties of the user to expand.

  • operations returns the operations that the user is allowed to do.
  • details.personal returns the ‘Personal’ details in the user’s profile, like the ‘Email’ and ‘Phone’.
  • details.business returns the ‘Company’ details in the user’s profile, like the ‘Position’ and ‘Department’.
  • personalSpace returns the user’s personal space, if it exists.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/current'

Response

Returned if the current user is returned.

403 Forbidden

Returned if the calling user does not have permission to use Confluence.

Get group memberships for user

GET /wiki/rest/api/user/memberof

Returns the groups that a user is a member of.

Permissions required: Permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Query parameters

accountId

string

The accountId of the user to be queried. Required, unless the username or key is specified. The accountId uniquely identifies a user across all Atlassian products.

key

string

The userKey of the user to be queried. Required, unless the username or accountId is specified. The key uniquely identifies a user in a Confluence instance and does not change.

limit

integer

The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0

start

integer

The starting index of the returned groups.

Default: 0, Minimum: 0

username

string

The username of the user to be queried. Required, unless the key or accountId is specified. The username uniquely identifies a user in a Confluence instance but can change if the user is renamed.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/memberof'

Response

Returned if the requested groups are returned.

403 Forbidden

Returned if the calling user does not have permission to use Confluence.

Get content watch status

GET /wiki/rest/api/user/watch/content/{contentId}

Returns whether a user is watching a piece of content. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Path parameters

contentId REQUIRED

string

The ID of the content to be queried for whether the specified user is watching it.

Query parameters

accountId

string

The accountId of the user to be queried for whether they are watching the content. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user to be queried for whether they are watching the content. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user to be queried for whether they are watching the content. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/content/{contentId}'

Response

Returned if the requested watch status is returned.

403 Forbidden

Returned if;

  • The calling user does not have permission to view the content.
  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No content exists for the specified contentId.

404 Not Found

Returned if no contentId is specified.

Add content watcher

POST /wiki/rest/api/user/watch/content/{contentId}

Adds a user as a watcher to a piece of content. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

Apps cannot access this REST resource.

Response content type: application/json

Request

Path parameters

contentId REQUIRED

string

The ID of the content to add the watcher to.

Query parameters

accountId

string

The accountId of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/content/{contentId}'

Response

204 No Content

Returned if the watcher was successfully created. No response body is returned.

403 Forbidden

Returned if;

  • The X-Atlassian-Token: no-check header is not specified.
  • The calling user does not have permission to view the content.
  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No content exists for the specified contentId.

404 Not Found

Returned if no contentId is specified.

Remove content watcher

DELETE /wiki/rest/api/user/watch/content/{contentId}

Removes a user as a watcher from a piece of content. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

Apps cannot access this REST resource.

Response content type: application/json

Request

Path parameters

contentId REQUIRED

string

The ID of the content to remove the watcher from.

Query parameters

accountId

string

The accountId of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/content/{contentId}'

Response

204 No Content

Returned if the watcher was successfully deleted. No response body is returned.

403 Forbidden

Returned if;

  • The X-Atlassian-Token: no-check header is not specified.
  • The calling user does not have permission to view the content.
  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No content exists for the specified contentId.

404 Not Found

Returned if no contentId is specified.

Get label watch status

GET /wiki/rest/api/user/watch/label/{labelName}

Returns whether a user is watching a label. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Path parameters

labelName REQUIRED

string

The name of the label to be queried for whether the specified user is watching it.

Query parameters

accountId

string

The accountId of the user to be queried for whether they are watching the label. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user to be queried for whether they are watching the label. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user to be queried for whether they are watching the label. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/label/{labelName}'

Response

Returned if the requested watch status is returned.

403 Forbidden

Returned if;

  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No label exists for the specified labelName.

404 Not Found

Returned if no labelName is specified.

Add label watcher

POST /wiki/rest/api/user/watch/label/{labelName}

Adds a user as a watcher to a label. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

Apps cannot access this REST resource.

Response content type: application/json

Request

Path parameters

labelName REQUIRED

string

The name of the label to add the watcher to.

Query parameters

accountId

string

The accountId of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/label/{labelName}'

Response

204 No Content

Returned if the watcher was successfully created. No response body is returned.

403 Forbidden

Returned if;

  • The X-Atlassian-Token: no-check header is not specified.
  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No label exists for the specified labelName.

404 Not Found

Returned if no labelName is specified.

Remove label watcher

DELETE /wiki/rest/api/user/watch/label/{labelName}

Removes a user as a watcher from a label. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

Apps cannot access this REST resource.

Response content type: application/json

Request

Path parameters

labelName REQUIRED

string

The name of the label to remove the watcher from.

Query parameters

accountId

string

The accountId of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/label/{labelName}'

Response

204 No Content

Returned if the watcher was successfully deleted. No response body is returned.

403 Forbidden

Returned if;

  • The X-Atlassian-Token: no-check header is not specified.
  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No label exists for the specified labelName.

404 Not Found

Returned if no labelName is specified.

Get space watch status

GET /wiki/rest/api/user/watch/space/{spaceKey}

Returns whether a user is watching a space. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

App scope required: READ

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to be queried for whether the specified user is watching it.

Query parameters

accountId

string

The accountId of the user to be queried for whether they are watching the space. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user to be queried for whether they are watching the space. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user to be queried for whether they are watching the space. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/space/{spaceKey}'

Response

Returned if the requested watch status is returned.

403 Forbidden

Returned if;

  • The calling user does not have permission to view the space.
  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No space exists for the specified spaceKey.

404 Not Found

Returned if no spaceKey is specified.

Add space watcher

POST /wiki/rest/api/user/watch/space/{spaceKey}

Adds a user as a watcher to a space. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

Apps cannot access this REST resource.

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to add the watcher to.

Query parameters

accountId

string

The accountId of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user that will be added as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --request POST \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/space/{spaceKey}'

Response

204 No Content

Returned if the watcher was successfully created. No response body is returned.

403 Forbidden

Returned if;

  • The X-Atlassian-Token: no-check header is not specified.
  • The calling user does not have permission to view the space.
  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No space exists for the specified spaceKey.

404 Not Found

Returned if no spaceKey is specified.

Remove space watch

DELETE /wiki/rest/api/user/watch/space/{spaceKey}

Removes a user as a watcher from a space. Choose the user by doing one of the following:

  • Specify a user via a query parameter: Use the username, key, or accountId to identify the user. The user making the request must be a Confluence administrator.
  • Do not specify a user: The currently logged-in user will be used.

Permissions required: ‘Confluence Administrator’ global permission if specifying a user, otherwise permission to access the Confluence site (‘Can use’ global permission).

Apps cannot access this REST resource.

Response content type: application/json

Request

Path parameters

spaceKey REQUIRED

string

The key of the space to remove the watcher from.

Query parameters

accountId

string

The accountId of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

key

string

The key of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

username

string

The username of the user that will be removed as a watcher. Only one of username, key, accountId can be used to identify the user in the request.

Example

curl --request DELETE \
  --user email@example.com:<api_token> \
  --header 'Accept: application/json' \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/user/watch/space/{spaceKey}'

Response

204 No Content

Returned if the watcher was successfully deleted. No response body is returned.

403 Forbidden

Returned if;

  • The X-Atlassian-Token: no-check header is not specified.
  • The calling user does not have permission to view the space.
  • A user is specified via a query parameter and the calling user is not a Confluence administrator.
  • No space exists for the specified spaceKey.

404 Not Found

Returned if no spaceKey is specified.