Icon

Confluence (version v1.*.*)

add_group_to_content_restriction

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.

Parameters

groupName (required)

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

Type: string

id (required)

The ID of the content that the restriction applies to.

Type: string

operationKey (required)

The operation that the restriction applies to.

Type: string

Potential values: read, update

add_labels_to_content

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.

Parameters

id (required)

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

Type: string

$body

The labels to add to the content.

Type: array

[ {
"prefix" : "The prefix for the label.",
"name" : "The name of the label, which will be shown in the UI."
} ]

add_restrictions

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.

Parameters

id (required)

The ID of the content to add restrictions to.

Type: string

$body

The restrictions to be added to the content.

Type: array

[ {
"restrictions" : {
"user" : [ {
"accountId" : "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. Required, unless `username` or `userKey` is specified.",
"type" : "Set to 'known'.",
"userKey" : "This property has been deprecated due to privacy changes. Use `accountId` instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe user key of the user. Required, unless `accountId` or `username` is specified.",
"username" : "This property has been deprecated due to privacy changes. Use `accountId` instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe username of the user. For example, _admin_. Required, unless `accountId` or `userKey` is specified."
} ],
"group" : [ {
"name" : "The name of the group.",
"type" : "Set to 'group'."
} ]
},
"operation" : "The restriction operation applied to content."
} ]

expand

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.

Type: array

[ "string. Possible values: restrictions.user | restrictions.group | content" ]

add_user_to_content_restriction

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

Permissions required:
Permission to edit the content.

Parameters

id (required)

The ID of the content that the restriction applies to.

Type: string

operationKey (required)

The operation that the restriction applies to.

Type: string

accountId

The account ID of the user to add to the content restriction. The accountId uniquely identifies the user across
all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to add to the content restriction. Required, unless the username or accountId is specified.

Type: string

userName

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to add to the content restriction. Required, unless the key or accountId is specified.

Type: string

add_watcher_to_content

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

contentId (required)

The ID of the content to add the watcher to.

Type: string

accountId

The accountId of the user to be added as a watcher. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be added as a watcher. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be added as a watcher. Required, unless the key or accountId is specified.

Type: string

add_watcher_to_label

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

labelName (required)

The name of the label to add the watcher to.

Type: string

accountId

The accountId of the user to be added as a watcher. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be added as a watcher. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be added as a watcher. Required, unless the key or accountId is specified.

Type: string

add_watcher_to_space

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

spaceKey (required)

The key of the space to add the watcher to.

Type: string

accountId

The accountId of the user to be added as a watcher. The accountId uniquely identifies the user across all
Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be added as a watcher. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be added as a watcher. Required, unless the key or accountId is specified.

Type: string

convert_content_body

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.

Parameters

to (required)

The name of the target format for the content body.

Type: string

$body

The content body to convert.

Type: object

{
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
}

contentIdContext

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 ``
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.

Type: string

embeddedContentRender

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.

Type: string

Potential values: current, version-at-save

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

spaceKeyContext

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 ``
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.

Type: string

convert_users_to_account_ids_in_cql

Converts one or more CQL queries with user identifiers (username or user key)
to equivalent CQL queries with account IDs.

You may wish to use this operation if your system stores CQL queries and you
want to make them GDPR-compliant. For more information about GDPR-related changes,
see the migration guide.

Permissions required: None

Parameters

$body

The CQL queries to convert.

Type: object

{
"queryStrings" : [ "string" ]
}

copy_page_hierarchy

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.

Parameters

id (required)

Type: string

$body

Request object from json post body

Type: object

{
"copyAttachments" : "boolean",
"originalPageId" : "string",
"copyPermissions" : "boolean",
"copyLabels" : "boolean",
"copyProperties" : "boolean",
"destinationPageId" : "ContentId",
"titleOptions" : {
"search" : "string",
"prefix" : "string",
"replace" : "string"
}
}

create_audit_record

Creates a record in the audit log.

Permissions required:
'Confluence Administrator' global permission.

Parameters

$body

The record to be created in the audit log.

Type: object

{
"summary" : "The summary of the event, which is displayed in the 'Change' column on\nthe audit log in the Confluence UI.",
"changedValues" : [ {
"newValue" : "Required string",
"name" : "Required string",
"oldValue" : "Required string"
} ],
"author" : {
"operations" : { },
"displayName" : "The name that is displayed on the audit log in the Confluence UI.",
"type" : "Set to 'user'.",
"userKey" : "The userKey of the user that actioned the event.",
"username" : "The username of the user that actioned the event."
},
"affectedObject" : {
"name" : "Required string",
"objectType" : "Required string"
},
"description" : "A long description of the event, which is displayed in the 'Description'\nfield on the audit log in the Confluence UI.",
"associatedObjects" : [ {
"name" : "Required string",
"objectType" : "Required string"
} ],
"sysAdmin" : "Indicates whether the event was actioned by a system administrator.",
"creationDate" : "The creation date-time of the audit record, as a timestamp. This is converted\nto a date-time display in the Confluence UI. If the `creationDate` is not\nspecified, then it will be set to the timestamp for the current date-time.",
"category" : "The category of the event, which is displayed in the 'Event type' column\non the audit log in the Confluence UI.",
"remoteAddress" : "The IP address of the computer where the event was initiated from."
}

create_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.

By default, the following objects are expanded: space, history, version.

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

Parameters

$body

The new content to be created. Set the representation to the name of the body
format type. For example, if you use storage for the body format, set
'representation=storage'.

If you are not sure how to generate the different 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.

Type: object

{
"id" : "The ID of the draft content. Required when publishing a draft.",
"title" : "Required string",
"type" : "The type of the new content. Custom content types defined by apps are also supported.",
"ancestors" : [ {
"id" : "The `id` of the parent content."
} ],
"body" : {
"view" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"export_view" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"styled_view" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"storage" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"editor2" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"anonymous_export_view" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
}
},
"space" : {
"key" : "The key of the space."
},
"status" : "The status of the new content."
}

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

status

Filter the returned content by status.

Type: string

create_content_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.

Parameters

$body

The content template to be created.
The content body must be in 'storage' format.

Type: object

{
"templateType" : "The type of the new template. Set to `page`.",
"name" : "The name of the new template.",
"description" : "A description of the new template.",
"body" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"space" : {
"key" : "Required string"
},
"labels" : [ {
"prefix" : "Required string",
"name" : "Required string",
"id" : "Required string",
"label" : "Required string"
} ]
}

create_private_space

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.

Parameters

$body

The space to be created.

Type: object

{
"name" : "The name of the new space.",
"description" : {
"plain" : {
"value" : "The space description.",
"representation" : "Set to 'plain'."
}
},
"key" : "The key for the new space. Format: See [Space\nkeys](https://confluence.atlassian.com/x/lqNMMQ)."
}

create_property_for_content

Creates a property for an existing piece of content. For more information
about content properties, see Confluence entity properties.

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.

Parameters

id (required)

The ID of the content to add the property to.

Type: string

$body

The content property to be created.

Type: object

{
"value" : { },
"key" : "The key of the new property."
}

create_property_for_key_for_content

Creates a property for an existing piece of content. For more information
about content properties, see Confluence entity properties.

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.

Parameters

id (required)

The ID of the content to add the property to.

Type: string

key (required)

The key of the content property. Required.

Type: string

$body

The content property to be created.

Type: object

{
"value" : { }
}

create_property_for_key_for_space

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.

Parameters

key (required)

The key of the property to be created.

Type: string

spaceKey (required)

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

Type: string

$body

The space property to be created.

Type: object

{
"value" : { }
}

create_property_for_space

Creates a new space property.

Permissions required:
‘Admin’ permission for the space.

Parameters

spaceKey (required)

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

Type: string

$body

The space property to be created.

Type: object

{
"value" : { },
"key" : "The key of the new property."
}

create_relationship

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).

Parameters

relationName (required)

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.

Type: string

sourceKey (required)

  • 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.

Type: string

sourceType (required)

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

Type: string

Potential values: user, content, space

targetKey (required)

  • 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.

Type: string

targetType (required)

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

Type: string

Potential values: user, content, space

sourceStatus

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

Type: string

sourceVersion

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

Type: integer

targetStatus

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

Type: string

targetVersion

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

Type: integer

create_space

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

Permissions required:
'Create Space(s)' global permission.

Parameters

$body

The space to be created.

Type: object

{
"permissions" : [ {
"anonymousAccess" : "Grant anonymous users permission to use the operation.",
"subjects" : {
"_expandable" : {
"user" : "string",
"group" : "string"
},
"user" : {
"size" : "Required integer",
"results" : [ {
"_links" : "Required object",
"displayName" : "The display name of the user. Depending on the user's privacy setting, this may be the same as publicName.",
"accountType" : "The account type of the user, may return empty string if unavailable.",
"type" : "Required string. Possible values: known | unknown | anonymous | user",
"userKey" : "This property has been deprecated in favor of `accountId`, due to privacy changes. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe user key of the user.",
"accountId" : "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.",
"profilePicture" : {
"path" : "Required string",
"isDefault" : "Required boolean",
"width" : "Required integer",
"height" : "Required integer"
},
"operations" : [ {
"targetType" : "The space or content type that the operation applies to.",
"operation" : "The operation itself."
} ],
"publicName" : "The public name or nickname of the user. Will always contain a value.",
"details" : {
"business" : {
"location" : "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"position" : "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"department" : "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
},
"personal" : {
"website" : "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"im" : "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"phone" : "This property has been deprecated due to privacy changes. There is no replacement. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.",
"email" : "This property has been deprecated due to privacy changes. Use the `User.email` property instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details."
}
},
"_expandable" : {
"operations" : "string",
"details" : "string",
"personalSpace" : "string"
},
"email" : "The email address of the user. Depending on the user's privacy setting, this may return an empty string.",
"username" : "This property has been deprecated in favor of `accountId`, due to privacy changes. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe username of the user. For example, _admin_.",
"personalSpace" : {
"settings" : {
"_links" : "Required object",
"routeOverrideEnabled" : "Defines whether an override for the space home should be used. This is\nused in conjunction with a space theme provided by an app. For\nexample, if this property is set to true, a theme can display a page\nother than the space homepage when users visit the root URL for a\nspace. This property allows apps to provide content-only theming\nwithout overriding the space home."
},
"metadata" : {
"labels" : {
"size" : "Required integer",
"_links" : "Required object",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ {
"prefix" : "Required string",
"name" : "Required string",
"id" : "Required string",
"label" : "Required string"
} ]
}
},
"_links" : "Required object",
"icon" : {
"path" : "Required string",
"isDefault" : "Required boolean",
"width" : "Required integer",
"height" : "Required integer"
},
"description" : {
"view" : {
"embeddedContent" : [ { } ],
"value" : "Required string",
"representation" : "Required string. Possible values: plain | view"
},
"plain" : {
"embeddedContent" : [ { } ],
"value" : "Required string",
"representation" : "Required string. Possible values: plain | view"
}
},
"history" : {
"createdDate" : "Required date-time"
},
"type" : "Required string",
"operations" : [ {
"targetType" : "The space or content type that the operation applies to.",
"operation" : "The operation itself."
} ],
"lookAndFeel" : {
"bordersAndDividers" : {
"color" : "Required string"
},
"headings" : {
"color" : "Required string"
},
"header" : {
"button" : {
"backgroundColor" : "Required string",
"color" : "Required string"
},
"backgroundColor" : "Required string",
"primaryNavigation" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string",
"color" : "Required string"
}
},
"search" : {
"backgroundColor" : "Required string",
"color" : "Required string"
},
"secondaryNavigation" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string",
"color" : "Required string"
}
}
},
"links" : {
"color" : "Required string"
},
"menus" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string"
}
},
"content" : {
"container" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
},
"screen" : {
"gutterRight" : "Required string",
"gutterLeft" : "Required string",
"gutterTop" : "Required string",
"backgroundColor" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string",
"gutterBottom" : "Required string"
},
"header" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
},
"body" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
}
}
},
"permissions" : [ "SpacePermission" ],
"name" : "Required string",
"theme" : {
"name" : "Required string",
"icon" : {
"path" : "Required string",
"isDefault" : "Required boolean",
"width" : "Required integer",
"height" : "Required integer"
},
"description" : "Required string",
"themeKey" : "Required string",
"_links" : "Required object"
},
"id" : "Required integer",
"_expandable" : {
"settings" : "string",
"metadata" : "string",
"operations" : "string",
"lookAndFeel" : "string",
"permissions" : "string",
"icon" : "string",
"description" : "string",
"theme" : "string",
"history" : "string",
"homepage" : "string"
},
"key" : "Required string",
"homepage" : {
"container" : { },
"_links" : "object",
"restrictions" : {
"read" : {
"_links" : "Required object",
"restrictions" : {
"_expandable" : {
"user" : "string",
"group" : "string"
},
"user" : {
"size" : "Required integer",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ "User" ]
},
"group" : {
"size" : "Required integer",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ {
"_links" : "Required object",
"name" : "Required string",
"type" : "Required string. Possible values: group"
} ]
}
},
"_expandable" : {
"restrictions" : "string",
"content" : "string"
},
"operation" : "Required string. Possible values: administer | copy | create | delete | export | move | purge | purge_version | read | restore | update | use",
"content" : "Content"
},
"_links" : "Required object",
"update" : {
"_links" : "Required object",
"restrictions" : {
"_expandable" : {
"user" : "string",
"group" : "string"
},
"user" : {
"size" : "Required integer",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ "User" ]
},
"group" : {
"size" : "Required integer",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ {
"_links" : "Required object",
"name" : "Required string",
"type" : "Required string. Possible values: group"
} ]
}
},
"_expandable" : {
"restrictions" : "string",
"content" : "string"
},
"operation" : "Required string. Possible values: administer | copy | create | delete | export | move | purge | purge_version | read | restore | update | use",
"content" : "Content"
}
},
"history" : {
"lastUpdated" : {
"number" : "Required integer",
"minorEdit" : "Required boolean",
"_links" : "Required object",
"by" : "Required User",
"friendlyWhen" : "Required string",
"collaborators" : {
"_links" : "object",
"userKeys" : [ "string" ],
"users" : [ "User" ]
},
"message" : "Required string",
"_expandable" : {
"collaborators" : "Required string",
"content" : "Required string"
},
"when" : "Required date-time",
"content" : "Content"
},
"createdDate" : "Required date-time",
"createdBy" : "Required User",
"_links" : "object",
"previousVersion" : {
"number" : "Required integer",
"minorEdit" : "Required boolean",
"_links" : "Required object",
"by" : "Required User",
"friendlyWhen" : "Required string",
"collaborators" : {
"_links" : "object",
"userKeys" : [ "string" ],
"users" : [ "User" ]
},
"message" : "Required string",
"_expandable" : {
"collaborators" : "Required string",
"content" : "Required string"
},
"when" : "Required date-time",
"content" : "Content"
},
"contributors" : {
"publishers" : {
"_links" : "object",
"userKeys" : [ "string" ],
"users" : [ "User" ]
}
},
"_expandable" : {
"lastUpdated" : "string",
"previousVersion" : "string",
"contributors" : "string",
"nextVersion" : "string"
},
"nextVersion" : {
"number" : "Required integer",
"minorEdit" : "Required boolean",
"_links" : "Required object",
"by" : "Required User",
"friendlyWhen" : "Required string",
"collaborators" : {
"_links" : "object",
"userKeys" : [ "string" ],
"users" : [ "User" ]
},
"message" : "Required string",
"_expandable" : {
"collaborators" : "Required string",
"content" : "Required string"
},
"when" : "Required date-time",
"content" : "Content"
},
"latest" : "Required boolean"
},
"type" : "Required string",
"title" : "Required string",
"body" : {
"view" : {
"webresource" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"keys" : [ "string" ],
"superbatch" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"metatags" : "string",
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"contexts" : [ "string" ],
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"embeddedContent" : [ {
"entityId" : "integer",
"entity" : { }
} ],
"_expandable" : {
"content" : "string"
},
"value" : "Required string",
"representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
},
"export_view" : {
"webresource" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"keys" : [ "string" ],
"superbatch" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"metatags" : "string",
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"contexts" : [ "string" ],
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"embeddedContent" : [ {
"entityId" : "integer",
"entity" : { }
} ],
"_expandable" : {
"content" : "string"
},
"value" : "Required string",
"representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
},
"styled_view" : {
"webresource" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"keys" : [ "string" ],
"superbatch" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"metatags" : "string",
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"contexts" : [ "string" ],
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"embeddedContent" : [ {
"entityId" : "integer",
"entity" : { }
} ],
"_expandable" : {
"content" : "string"
},
"value" : "Required string",
"representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
},
"storage" : {
"webresource" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"keys" : [ "string" ],
"superbatch" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"metatags" : "string",
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"contexts" : [ "string" ],
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"embeddedContent" : [ {
"entityId" : "integer",
"entity" : { }
} ],
"_expandable" : {
"content" : "string"
},
"value" : "Required string",
"representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
},
"_expandable" : {
"editor" : "string",
"view" : "string",
"export_view" : "string",
"styled_view" : "string",
"storage" : "string",
"editor2" : "string",
"anonymous_export_view" : "string"
},
"editor2" : {
"webresource" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"keys" : [ "string" ],
"superbatch" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"metatags" : "string",
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"contexts" : [ "string" ],
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"embeddedContent" : [ {
"entityId" : "integer",
"entity" : { }
} ],
"_expandable" : {
"content" : "string"
},
"value" : "Required string",
"representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
},
"anonymous_export_view" : {
"webresource" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"keys" : [ "string" ],
"superbatch" : {
"uris" : {
"all" : "string",
"css" : "string",
"js" : "string"
},
"metatags" : "string",
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"contexts" : [ "string" ],
"tags" : {
"all" : "string",
"css" : "string",
"data" : "string",
"js" : "string"
}
},
"embeddedContent" : [ {
"entityId" : "integer",
"entity" : { }
} ],
"_expandable" : {
"content" : "string"
},
"value" : "Required string",
"representation" : "Required string. Possible values: view | export_view | styled_view | storage | editor2 | anonymous_export_view"
}
},
"version" : {
"number" : "Required integer",
"minorEdit" : "Required boolean",
"_links" : "Required object",
"by" : "Required User",
"friendlyWhen" : "Required string",
"collaborators" : {
"_links" : "object",
"userKeys" : [ "string" ],
"users" : [ "User" ]
},
"message" : "Required string",
"_expandable" : {
"collaborators" : "Required string",
"content" : "Required string"
},
"when" : "Required date-time",
"content" : "Content"
},
"descendants" : {
"attachment" : {
"size" : "Required integer",
"_links" : "Required object",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ "Content" ]
},
"_links" : "Required object",
"comment" : {
"size" : "Required integer",
"_links" : "Required object",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ "Content" ]
},
"page" : {
"size" : "Required integer",
"_links" : "Required object",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ "Content" ]
},
"_expandable" : {
"attachment" : "string",
"comment" : "string",
"page" : "string"
}
},
"space" : "Space",
"childTypes" : {
"attachment" : {
"_links" : "Required object",
"value" : "Required boolean"
},
"comment" : {
"_links" : "Required object",
"value" : "Required boolean"
},
"page" : {
"_links" : "Required object",
"value" : "Required boolean"
},
"_expandable" : {
"all" : "string",
"attachment" : "string",
"comment" : "string",
"page" : "string"
}
},
"operations" : [ {
"targetType" : "The space or content type that the operation applies to.",
"operation" : "The operation itself."
} ],
"children" : {
"attachment" : {
"size" : "Required integer",
"_links" : "Required object",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ "Content" ]
},
"_links" : "Required object",
"comment" : {
"size" : "Required integer",
"_links" : "Required object",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ "Content" ]
},
"page" : {
"size" : "Required integer",
"_links" : "Required object",
"start" : "Required integer",
"limit" : "Required integer",
"results" : [ "Content" ]
},
"_expandable" : {
"attachment" : "string",
"comment" : "string",
"page" : "string"
}
},
"id" : "Required string",
"ancestors" : [ "Content" ],
"_expandable" : {
"childTypes" : "string",
"container" : "string",
"metadata" : "string",
"operations" : "string",
"children" : "string",
"restrictions" : "string",
"history" : "string",
"ancestors" : "string",
"body" : "string",
"version" : "string",
"descendants" : "string",
"space" : "string"
},
"status" : "Required string"
},
"status" : "Required string"
}
} ]
},
"group" : {
"size" : "Required integer",
"results" : [ {
"_links" : "Required object",
"name" : "Required string",
"type" : "Required string. Possible values: group"
} ]
}
},
"operation" : {
"targetType" : "The space or content type that the operation applies to.",
"operation" : "The operation itself."
},
"unlicensedAccess" : "Grants access to unlicensed users from JIRA Service Desk when used\nwith the 'read space' operation."
} ],
"name" : "The name of the new space.",
"description" : {
"plain" : {
"value" : "The space description.",
"representation" : "Set to 'plain'."
}
},
"key" : "The key for the new space. Format: See [Space\nkeys](https://confluence.atlassian.com/x/lqNMMQ)."
}

delete_content

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.

Parameters

id (required)

The ID of the content to be deleted.

Type: string

status

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

Type: string

delete_property_for_content

Deletes a content property. For more information about content properties, see
Confluence entity properties.

Permissions required:
Permission to update the content.

Parameters

id (required)

The ID of the content that the property belongs to.

Type: string

key (required)

The key of the property.

Type: string

delete_property_for_space

Deletes a space property.

Permissions required:
‘Admin’ permission for the space.

Parameters

key (required)

The key of the property to be deleted.

Type: string

spaceKey (required)

The key of the space that the property is in.

Type: string

delete_relationship

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.

Parameters

relationName (required)

The name of the relationship.

Type: string

sourceKey (required)

  • 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.

Type: string

sourceType (required)

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

Type: string

Potential values: user, content, space

targetKey (required)

  • 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.

Type: string

targetType (required)

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

Type: string

Potential values: user, content, space

sourceStatus

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

Type: string

sourceVersion

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

Type: integer

targetStatus

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

Type: string

targetVersion

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

Type: integer

delete_restrictions

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

Permissions required:
Permission to edit the content.

Parameters

id (required)

The ID of the content to remove restrictions from.

Type: string

expand

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.

Type: array

[ "string. Possible values: restrictions.user | restrictions.group | content" ]

delete_space

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.

Parameters

spaceKey (required)

The key of the space to delete.

Type: string

delete_version_for_content

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.

Parameters

id (required)

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

Type: string

versionNumber (required)

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

Type: integer

export_audit_records

Exports audit records as a CSV file or ZIP file.

Permissions required:
'Confluence Administrator' global permission.

Parameters

endDate

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

Type: string

format

The format of the export file for the audit records.

Type: string

Potential values: csv, zip

searchString

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

Type: string

startDate

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

Type: string

find_sources_for_target

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.

Parameters

relationName (required)

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

Type: string

sourceType (required)

The source entity type of the relationship.

Type: string

Potential values: user, content, space

targetKey (required)

The identifier for the target entity:

  • If targetType is user, then specify either current (logged-in user), the user key of the user, or
    the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
    migration guide
    for details.
  • If targetType is 'content', then specify the content ID.
  • If targetType is 'space', then specify the space key.

Type: string

targetType (required)

The target entity type of the relationship.

Type: string

Potential values: user, content, space

expand

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.

Type: array

[ "string. Possible values: relationData | source | target" ]

sourceStatus

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

Type: string

sourceVersion

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

Type: integer

targetStatus

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

Type: string

targetVersion

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

Type: integer

find_target_from_source

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.

Parameters

relationName (required)

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

Type: string

sourceKey (required)

The identifier for the source entity:

  • If sourceType is user, then specify either current (logged-in user), the user key of the user, or
    the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
    migration guide
    for details.
  • If sourceType is 'content', then specify the content ID.
  • If sourceType is 'space', then specify the space key.

Type: string

sourceType (required)

The source entity type of the relationship.

Type: string

Potential values: user, content, space

targetType (required)

The target entity type of the relationship.

Type: string

Potential values: user, content, space

expand

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.

Type: array

[ "string. Possible values: relationData | source | target" ]

sourceStatus

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

Type: string

sourceVersion

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

Type: integer

targetStatus

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

Type: string

targetVersion

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

Type: integer

get_anonymous_user

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).

Parameters

expand

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

  • operations returns the operations that the user is allowed to do.

Type: array

[ "string. Possible values: operations" ]

get_bulk_account_ids_for_users

Returns the accountIds for the users specified in the key or username parameters. Note that multiple key and username parameters can be specified.

Permissions required:
'Confluence Administrator' global permission if specifying a user, otherwise
permission to access the Confluence site ('Can use' global permission).

Parameters

key

The key of a user. To specify multiple users, pass multiple key parameters separated by ampersands.
For example, key=mia&key=alana. Required if username isn't provided. Cannot be provided if username is present.

Type: array

[ "string" ]

username

The username of a user. To specify multiple users, pass multiple username parameters separated by ampersands.
For example, username=mia&username=alana. Required if key isn't provided. Cannot be provided if key is present.

Type: array

[ "string" ]

get_bulk_privacy_unsafe_user_emails

Returns user email addresses for a set of accountIds. This API is only available to apps approved by
Atlassian, according to these guidelines.

Any accounts which are not available will not be included in the result.

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

Parameters

accountId (required)

The account IDs of the users.

Type: array

[ "string" ]

get_bulk_users

Returns user details for the ids provided in request.

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

Parameters

accountId (required)

A list of accountId's of users to be returned.

Type: string

expand

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'.
    Note that these fields have been deprecated due to privacy changes. See the
    migration guide
    for details.
  • details.business returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.
    Note that these fields have been deprecated due to privacy changes. See the
    migration guide
    for details.
  • personalSpace returns the user's personal space, if it exists.

Type: array

[ "string. Possible values: operations | details.personal | details.business | personalSpace" ]

get_content_by_id

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

By default, the following objects are expanded: space, history, version.

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

Parameters

id (required)

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

Type: string

embeddedContentRender

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.

Type: string

Potential values: current, version-at-save

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

status

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.

Type: array

[ "string. Possible values: current | trashed | draft | any" ]

trigger

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.

Type: string

Potential values: viewed

version

The version number of the content to be returned.

Type: integer

get_content_by_type_for_space

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.

Parameters

spaceKey (required)

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

Type: string

type (required)

The type of content to return.

Type: string

Potential values: page, blogpost

depth

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

Type: string

Potential values: all, root

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

get_content_for_space

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.

Parameters

spaceKey (required)

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

Type: string

depth

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

Type: string

Potential values: all, root

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

get_content_restriction_status_for_group

Returns whether the specified content restriction applies to a group.
For example, if a page with id=123 has a read restriction for the admins group,
the following request will return true:

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

Note that a response of true does not guarantee that the group can view the page, as it does not account for
account-inherited restrictions, space permissions, or even product access. For more
information, see Confluence permissions.

Permissions required:
Permission to view the content.

Parameters

groupName (required)

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

Type: string

id (required)

The ID of the content that the restriction applies to.

Type: string

operationKey (required)

The operation that the restriction applies to.

Type: string

Potential values: read, update

get_content_restriction_status_for_user

Returns whether the specified content restriction applies to a user.
For example, if a page with id=123 has a read restriction for a user with an account ID of
384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192, the following request will return true:

https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192

Note that a response of true does not guarantee that the user can view the page, as it does not account for
account-inherited restrictions, space permissions, or even product access. For more
information, see Confluence permissions.

Permissions required:
Permission to view the content.

Parameters

id (required)

The ID of the content that the restriction applies to.

Type: string

operationKey (required)

The operation that is restricted.

Type: string

accountId

The account ID of the user to be queried for whether the content restriction applies to it. The accountId
uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be queried for whether the content restriction applies to it.
Required, unless the username or accountId is specified.

Type: string

userName

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be queried for whether the content restriction applies to it.
Required, unless the key or accountId is specified.

Type: string

get_content_template

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.

Parameters

contentTemplateId (required)

The ID of the content template to be returned.

Type: string

get_content_watch_status

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

contentId (required)

The ID of the content to be queried for whether the specified user is
watching it.

Type: string

accountId

The accountId of the user to be queried for whether they are watching the content. The accountId uniquely
identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be queried for whether they are watching the
content. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be queried for whether they are watching
the content. Required, unless the key or accountId is specified.

Type: string

get_current_user

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).

Parameters

expand

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'.
    Note that these fields have been deprecated due to privacy changes. See the
    migration guide
    for details.
  • details.business returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.
    Note that these fields have been deprecated due to privacy changes. See the
    migration guide
    for details.
  • personalSpace returns the user's personal space, if it exists.

Type: array

[ "string. Possible values: operations | details.personal | details.business | personalSpace" ]

get_global_theme

This operation has no parameters

get_group

Returns a user group for a given group name.

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

Parameters

groupName (required)

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

Type: string

get_history_for_content

Returns the most recent update for a piece of content.

Permissions required: Permission to view the content.

Parameters

id (required)

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

Type: string

expand

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.

Type: array

[ "string. Possible values: lastUpdated | previousVersion | contributors | nextVersion" ]

get_look_and_feel_settings

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

Parameters

spaceKey

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.

Type: string

get_macro_body_by_macro_id

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.

Parameters

id (required)

The ID for the content that contains the macro.

Type: string

macroId (required)

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'.

Type: string

version (required)

The version of the content that contains the macro.

Type: integer

get_privacy_unsafe_user_email

Returns a user's email address. This API is only available to apps approved by
Atlassian, according to these guidelines.

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

Parameters

accountId (required)

The account ID of the user, which uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required.

Type: string

get_property_for_content

Returns a content property for a piece of content. For more information, see
Confluence entity properties.

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

Parameters

id (required)

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

Type: string

key (required)

The key of the content property.

Type: string

expand

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.

Type: array

[ "string. Possible values: content | version" ]

get_property_for_space

Returns a space property.

Permissions required: ‘View’ permission for the space.

Parameters

key (required)

The key of the space property.

Type: string

spaceKey (required)

The key of the space that the property is in.

Type: string

expand

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.

Type: array

[ "string. Possible values: version | space" ]

get_relationship

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.

Parameters

relationName (required)

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.

Type: string

sourceKey (required)

  • The identifier for the source entity:

  • If sourceType is user, then specify either current (logged-in user), the user key of the user, or
    the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
    migration guide
    for details.

  • If sourceType is 'content', then specify the content ID.

  • If sourceType is 'space', then specify the space key.

Type: string

sourceType (required)

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

Type: string

Potential values: user, content, space

targetKey (required)

The identifier for the target entity:

  • If targetType is user, then specify either current (logged-in user), the user key of the user, or
    the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the
    migration guide
    for details.
  • If targetType is 'content', then specify the content ID.
  • If targetType is 'space', then specify the space key.

Type: string

targetType (required)

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

Type: string

Potential values: user, content, space

expand

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.

Type: array

[ "string. Possible values: relationData | source | target" ]

sourceStatus

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

Type: string

sourceVersion

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

Type: integer

targetStatus

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

Type: string

targetVersion

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

Type: integer

get_retention_period

This operation has no parameters

get_space

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.

Parameters

spaceKey (required)

The key of the space to be returned.

Type: string

expand

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, including the color scheme.
  • permissions returns the permissions for the space. Note that this may return permissions for deleted groups,
    because deleting a group doesn't remove associated space permissions.
  • 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.

Type: array

[ "string. Possible values: settings | metadata.labels | operations | lookAndFeel | permissions | icon | description.plain | description.view | theme | homepage" ]

get_system_info

This operation has no parameters

get_task

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).

Parameters

id (required)

The ID of the task.

Type: string

get_theme

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

Permissions required: None

Parameters

themeKey (required)

The key of the theme to be returned.

Type: string

get_theme_for_space

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.

Parameters

spaceKey (required)

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

Type: string

get_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).

Parameters

accountId

The account ID of the user, which uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

expand

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'.
    Note that these fields have been deprecated due to privacy changes. See the
    migration guide
    for details.
  • details.business returns the 'Company' details in the user's profile, like the 'Position' and 'Department'.
    Note that these fields have been deprecated due to privacy changes. See the
    migration guide
    for details.
  • personalSpace returns the user's personal space, if it exists.

Type: array

[ "string. Possible values: operations | details.personal | details.business | personalSpace" ]

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

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.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

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.

Type: string

get_version_for_content

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.

Parameters

id (required)

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

Type: string

versionNumber (required)

The number of the version to be retrieved.

Type: integer

expand

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.

Type: array

[ "string. Possible values: collaborators | content" ]

is_watching_label

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

labelName (required)

The name of the label to be queried for whether the specified user is
watching it.

Type: string

accountId

The accountId of the user to be queried for whether they are watching the label. The accountId uniquely identifies
the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be queried for whether they are watching the label. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be queried for whether they are watching the label. Required, unless the key or accountId is specified.

Type: string

is_watching_space

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

spaceKey (required)

The key of the space to be queried for whether the specified user is
watching it.

Type: string

accountId

The accountId of the user to be queried for whether they are watching the space. The accountId uniquely identifies
the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be queried for whether they are watching the space. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be queried for whether they are watching the space. Required, unless the key or accountId is specified.

Type: string

list_all_descendants_of_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.

Parameters

id (required)

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

Type: string

type (required)

The type of descendants to return.

Type: string

Potential values: page, comment, attachment

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

list_attachments_for_content

Returns the attachments for a piece of content.

By default, the following objects are expanded: metadata.

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

Parameters

id (required)

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

Type: string

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

filename

Filter the results to attachments that match the filename.

Type: string

mediaType

Filter the results to attachments that match the media type.

Type: string

list_audit_records

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.

Parameters

endDate

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

Type: string

searchString

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

Type: string

startDate

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

Type: string

list_audit_records_for_time_period

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.

Parameters

number

The number of units for the time period.

Type: integer

searchString

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

Type: string

units

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

Type: string

Potential values: NANOS, MICROS, MILLIS, SECONDS, MINUTES, HOURS, HALF_DAYS, DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES

list_blueprint_templates

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).

Parameters

expand

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

  • body returns the content of the template in storage format.

Type: array

[ "string. Possible values: body" ]

spaceKey

The key of the space to be queried for templates. If the spaceKey
is not specified, global blueprint templates will be returned.

Type: string

list_children_of_content

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.

Parameters

id (required)

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

Type: string

expand

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.

Type: array

[ "string. Possible values: attachment | comment | page" ]

parentVersion

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

Type: integer

list_children_of_content_by_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.

Parameters

id (required)

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

Type: string

type (required)

The type of children to return.

Type: string

Potential values: page, comment, attachment

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

parentVersion

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

Type: integer

list_comments_for_content

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.

Parameters

id (required)

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

Type: string

depth

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

Type: string

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

location

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

Type: array

[ "string. Possible values: inline | footer | resolved" ]

parentVersion

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

Type: integer

list_content

Returns all content in a Confluence instance.

By default, the following objects are expanded: space, history, version.

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

Parameters

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

orderby

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'.

Type: string

postingDay

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

Type: string

spaceKey

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

Type: string

status

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.

Type: array

[ "string. Possible values: current | trashed | draft | any" ]

title

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

Type: string

trigger

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.

Type: string

Potential values: viewed

type

The type of content to return.

Type: string

Potential values: page, blogpost

list_content_templates

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.

Parameters

expand

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

  • body returns the content of the template in storage format.

Type: array

[ "string. Possible values: body" ]

spaceKey

The key of the space to be queried for templates. If the spaceKey
is not specified, global templates will be returned.

Type: string

list_descendants_for_content

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.

Parameters

id (required)

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

Type: string

expand

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.

Type: array

[ "string. Possible values: attachment | comment | page" ]

list_group_memberships_for_user

Returns the groups that a user is a member of.

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

Parameters

accountId

The account ID of the user, which uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The userKey of the user. Required, unless the username or accountId is specified. The key uniquely identifies
a user in a Confluence instance and does not change.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user. 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.

Type: string

list_groups

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).

This operation has no parameters

list_labels_for_content

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.

Parameters

id (required)

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

Type: string

prefix

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.

Type: string

Potential values: global, my, team

list_members_for_group

Returns the users that are members of a group.

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

Parameters

groupName (required)

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

Type: string

list_properties_for_content

Returns the properties for a piece of content. For more information
about content properties, see Confluence entity properties.

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

Parameters

id (required)

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

Type: string

expand

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.

Type: array

[ "string. Possible values: content | version" ]

list_properties_for_space

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.

Parameters

spaceKey (required)

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

Type: string

expand

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.

Type: array

[ "string. Possible values: version | space" ]

list_restrictions

Returns the restrictions on a piece of content.

Permissions required:
Permission to view the content.

Parameters

id (required)

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

Type: string

expand

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.

Type: array

[ "string. Possible values: restrictions.user | restrictions.group | content" ]

list_restrictions_by_operation

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.

Parameters

id (required)

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

Type: string

expand

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.

Type: array

[ "string. Possible values: restrictions.user | restrictions.group | content" ]

list_restrictions_for_operation

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

Permissions required:
Permission to view the content.

Parameters

id (required)

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

Type: string

operationKey (required)

The operation type of the restrictions to be returned.

Type: string

Potential values: read, update

expand

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.

Type: array

[ "string. Possible values: restrictions.user | restrictions.group | content" ]

list_settings_for_space

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

Permissions required:
'View' permission for the space.

Parameters

spaceKey (required)

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

Type: string

list_spaces

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.

Parameters

expand

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, including the color scheme.
  • permissions returns the permissions for the space. Note that this may return permissions for deleted groups,
    because deleting a group doesn't remove associated space permissions.
  • 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.

Type: array

[ "string. Possible values: settings | metadata.labels | operations | lookAndFeel | permissions | icon | description.plain | description.view | theme | homepage" ]

favourite

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

Type: boolean

favouriteUserKey

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.

Type: string

label

Filter the results to spaces based on their label.

Type: array

[ "string" ]

spaceKey

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

Type: array

[ "string" ]

status

Filter the results to spaces based on their status.

Type: string

Potential values: current, archived

type

Filter the results to spaces based on their type.

Type: string

Potential values: global, personal

list_tasks

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).

This operation has no parameters

list_themes

Returns all themes, not including the default theme.

Permissions required: None

This operation has no parameters

list_versions_for_content

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.

Parameters

id (required)

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

Type: string

expand

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.

Type: array

[ "string. Possible values: collaborators | content" ]

list_watchers_for_space

Returns a list of watchers of a space

Parameters

spaceKey (required)

The key of the space to get watchers.

Type: string

list_watches_for_page

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).

Parameters

id (required)

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

Type: string

list_watches_for_space

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).

Parameters

id (required)

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

Type: string

publish_legacy_draft

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

By default, the following objects are expanded: body.storage, history, space, version, ancestors.

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

Parameters

draftId (required)

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.

Type: string

$body

Type: object

{
"title" : "The title of the content. If you don't want to change the title,\nset this to the current title of the draft.",
"type" : "The type of content. Set this to `page`.",
"ancestors" : [ {
"id" : "The content ID of the ancestor."
} ],
"version" : {
"number" : "The version number. Set this to `1`."
},
"space" : {
"key" : "The key of the space"
},
"status" : "The status of the content. Set this to `current` or omit it altogether."
}

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

status

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.

Type: string

publish_shared_draft

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

By default, the following objects are expanded: body.storage, history, space, version, ancestors.

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

Parameters

draftId (required)

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.

Type: string

$body

Type: object

{
"title" : "The title of the content. If you don't want to change the title,\nset this to the current title of the draft.",
"type" : "The type of content. Set this to `page`.",
"ancestors" : [ {
"id" : "The content ID of the ancestor."
} ],
"version" : {
"number" : "The version number. Set this to `1`."
},
"space" : {
"key" : "The key of the space"
},
"status" : "The status of the content. Set this to `current` or omit it altogether."
}

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

status

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.

Type: string

remove_group_from_content_restriction

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.

Parameters

groupName (required)

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

Type: string

id (required)

The ID of the content that the restriction applies to.

Type: string

operationKey (required)

The operation that the restriction applies to.

Type: string

Potential values: read, update

remove_label_from_content

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.

Parameters

id (required)

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

Type: string

label (required)

The name of the label to be removed.

Type: string

remove_label_from_content_using_query_parameter

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.

Parameters

id (required)

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

Type: string

name

The name of the label to be removed.

Type: string

remove_template

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.

Parameters

contentTemplateId (required)

The ID of the template to be deleted.

Type: string

remove_user_from_content_restriction

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.

Parameters

id (required)

The ID of the content that the restriction applies to.

Type: string

operationKey (required)

The operation that the restriction applies to.

Type: string

Potential values: read, update

accountId

The account ID of the user to remove from the content restriction. The accountId uniquely identifies the user
across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to remove from the content restriction. Required, unless the username or accountId is specified.

Type: string

userName

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to remove from the content restriction. Required, unless the key or accountId is specified.

Type: string

remove_watch_from_space

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

spaceKey (required)

The key of the space to remove the watcher from.

Type: string

accountId

The accountId of the user to be removed as a watcher. The accountId uniquely identifies the user across all
Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.
Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be removed as a watcher. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be removed as a watcher. Required, unless the key or accountId is specified.

Type: string

remove_watcher_from_content

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

contentId (required)

The ID of the content to remove the watcher from.

Type: string

accountId

The accountId of the user to be removed as a watcher. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be removed as a watcher. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be removed as a watcher. Required, unless the key or accountId is specified.

Type: string

remove_watcher_from_label

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.
    Note that username and key have been deprecated in favor of accountId. See the
    migration guide
    for details.
  • 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).

Parameters

labelName (required)

The name of the label to remove the watcher from.

Type: string

accountId

The accountId of the user to be removed as a watcher. The accountId uniquely identifies the user across all Atlassian products.
For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. Required, unless username or userKey is specified.

Type: string

key

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The key of the user to be removed as a watcher. Required, unless the username or accountId is specified.

Type: string

username

This parameter has been deprecated due to privacy changes. Use accountId instead. See the
migration guide
for details.

The username of the user to be removed as a watcher. Required, unless the key or accountId is specified.

Type: string

reset_look_and_feel_settings

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.

Parameters

spaceKey

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.

Type: string

reset_theme_for_space

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

Permissions required:
'Admin' permission for the space.

Parameters

spaceKey (required)

The key of the space to reset the theme for.

Type: string

restore_version_for_content

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.

Parameters

id (required)

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

Type: string

$body

The content version to be restored.

Type: object

{
"operationKey" : "Set to 'RESTORE'.",
"params" : {
"message" : "Description for the version.",
"versionNumber" : "The version number to be restored."
}
}

expand

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.

Type: array

[ "string. Possible values: collaborators | content" ]

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.

Parameters

cql (required)

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

Type: string

cqlcontext

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}

Type: string

includeArchivedSpaces

Include content from archived spaces in the results.

Type: boolean

search_content_by_cql

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.

Parameters

cql

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

Type: string

cqlcontext

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.

Type: string

expand

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,
    including 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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. Note that
    this may return deleted groups, because deleting a group doesn't remove associated restrictions.
  • 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.

Type: array

[ "string. Possible values: childTypes.all | childTypes.attachment | childTypes.comment | childTypes.page | container | metadata.currentuser | metadata.properties | metadata.labels | metadata.frontend | operations | children.page | children.attachment | children.comment | restrictions.read.restrictions.user | restrictions.read.restrictions.group | restrictions.update.restrictions.user | restrictions.update.restrictions.group | history | history.lastUpdated | history.previousVersion | history.contributors | history.nextVersion | ancestors | body | version | descendants.page | descendants.attachment | descendants.comment | space" ]

search_user

Searches for users using user-specific queries from the
Confluence Query Language (CQL).

Note that some user fields may be set to null depending on the user's privacy settings.
These are: email, profilePicture, and displayName.

Parameters

cql (required)

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

Example queries:
cql=type=user will return all users
cql=user=“1234” will return user with accountId “1234”
You can also use IN, NOT IN, != operators
cql=user IN (“12”, “34") will return users with accountids “12” and “34”
cql=user.fullname~jo will return users with nickname/full name starting with “jo”
cql=user.accountid=“123” will return user with accountId “123”

Type: string

set_look_and_feel_settings

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.

Parameters

$body

The look and feel settings to be set.

Type: object

{
"custom" : {
"bordersAndDividers" : {
"color" : "Required string"
},
"headings" : {
"color" : "Required string"
},
"header" : {
"button" : {
"backgroundColor" : "Required string",
"color" : "Required string"
},
"backgroundColor" : "Required string",
"primaryNavigation" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string",
"color" : "Required string"
}
},
"search" : {
"backgroundColor" : "Required string",
"color" : "Required string"
},
"secondaryNavigation" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string",
"color" : "Required string"
}
}
},
"links" : {
"color" : "Required string"
},
"menus" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string"
}
},
"content" : {
"container" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
},
"screen" : {
"gutterRight" : "Required string",
"gutterLeft" : "Required string",
"gutterTop" : "Required string",
"backgroundColor" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string",
"gutterBottom" : "Required string"
},
"header" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
},
"body" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
}
}
},
"global" : {
"bordersAndDividers" : {
"color" : "Required string"
},
"headings" : {
"color" : "Required string"
},
"header" : {
"button" : {
"backgroundColor" : "Required string",
"color" : "Required string"
},
"backgroundColor" : "Required string",
"primaryNavigation" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string",
"color" : "Required string"
}
},
"search" : {
"backgroundColor" : "Required string",
"color" : "Required string"
},
"secondaryNavigation" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string",
"color" : "Required string"
}
}
},
"links" : {
"color" : "Required string"
},
"menus" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string"
}
},
"content" : {
"container" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
},
"screen" : {
"gutterRight" : "Required string",
"gutterLeft" : "Required string",
"gutterTop" : "Required string",
"backgroundColor" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string",
"gutterBottom" : "Required string"
},
"header" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
},
"body" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
}
}
},
"selected" : "The look and feel scheme. If you set this to `global`, you must specify\nthe current global look and feel settings as a `global` object in this\nrequest. Similarly, if you set this to `custom`, you must specify the\ncurrent custom look and feel settings as a `custom` object in this request."
}

spaceKey

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.

Type: string

set_retention_period

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.

Parameters

$body

The updated retention period.

Type: object

{
"number" : "The number of units for the retention period.",
"units" : "The unit of time that the retention period is measured in."
}

set_theme_for_space

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.

Parameters

spaceKey (required)

The key of the space to set the theme for.

Type: string

$body

Type: object

{
"themeKey" : "The key of the theme to be set as the space theme."
}

update_content

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.

Parameters

id (required)

The ID of the content to be updated.

Type: string

$body

The updated content.

Type: object

{
"title" : "The updated title of the content. If you are not changing this field, set this to the current `title`.",
"type" : "The type of content. Set this to the current type of the content.",
"ancestors" : [ {
"id" : "The `id` of the parent content."
} ],
"body" : {
"view" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"export_view" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"styled_view" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"storage" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"editor2" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"anonymous_export_view" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
}
},
"version" : {
"number" : "The version number."
},
"status" : "The updated status of the content. Note, if you change the status of a page from\n'current' to 'draft' and it has an existing draft, the existing draft will be deleted\nin favor of the updated page."
}

conflictPolicy

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

Type: string

Potential values: abort

status

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

Type: string

Potential values: current, trashed, historical, draft

update_content_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.

Parameters

$body

The updated content template.

Type: object

{
"templateType" : "The type of the template. Set to `page`.",
"name" : "The name of the template. Set to the current `name` if this field is\nnot being updated.",
"description" : "A description of the template.",
"templateId" : "The ID of the template being updated.",
"body" : {
"value" : "The body of the content in the relevant format.",
"representation" : "The content format type. Set the value of this property to\nthe name of the format being used, e.g. 'storage'."
},
"space" : {
"key" : "Required string"
},
"labels" : [ {
"prefix" : "Required string",
"name" : "Required string",
"id" : "Required string",
"label" : "Required string"
} ]
}

update_look_and_feel_settings

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.

Parameters

$body

The updated settings. All values for the settings must be included,
regardless of whether they are being changed.

One way to create the request body is to copy the settings from the
response body of Get look and feel settings
and modify it as needed.

Type: object

{
"bordersAndDividers" : {
"color" : "Required string"
},
"headings" : {
"color" : "Required string"
},
"header" : {
"button" : {
"backgroundColor" : "Required string",
"color" : "Required string"
},
"backgroundColor" : "Required string",
"primaryNavigation" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string",
"color" : "Required string"
}
},
"search" : {
"backgroundColor" : "Required string",
"color" : "Required string"
},
"secondaryNavigation" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string",
"color" : "Required string"
}
}
},
"links" : {
"color" : "Required string"
},
"menus" : {
"color" : "Required string",
"hoverOrFocus" : {
"backgroundColor" : "Required string"
}
},
"content" : {
"container" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
},
"screen" : {
"gutterRight" : "Required string",
"gutterLeft" : "Required string",
"gutterTop" : "Required string",
"backgroundColor" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string",
"gutterBottom" : "Required string"
},
"header" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
},
"body" : {
"padding" : "Required string",
"backgroundColor" : "Required string",
"borderRadius" : "Required string",
"background" : "Required string",
"backgroundImage" : "Required string",
"backgroundSize" : "Required string"
}
}
}

spaceKey

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.

Type: string

update_properties_for_attachment

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.

Parameters

attachmentId (required)

The ID of the attachment to update.

Type: string

id (required)

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

Type: string

$body

The details of the attachment to be updated.

Type: object

{
"container" : {
"id" : "The `id` of the parent content.",
"type" : "The content type. You can only attach attachments to content\nof type: `page`, `blogpost`."
},
"metadata" : {
"mediaType" : "The media type of the attachment, e.g. 'img/jpg'.",
"comment" : "The comment for this update."
},
"id" : "The ID of the attachment to be updated.",
"type" : "Set this to `attachment`.",
"title" : "The updated name of the attachment.",
"version" : {
"number" : "The version number."
}
}

update_property_for_content

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
Confluence entity properties.

Permissions required:
Permission to update the content.

Parameters

id (required)

The ID of the content that the property belongs to.

Type: string

key (required)

The key of the property.

Type: string

$body

The content property being updated.

Type: object

{
"value" : "The value of the property.",
"version" : {
"number" : "The new version for the updated content property. Set this to the\ncurrent version number incremented by one. To get the current\nversion number, use 'Get content property' and retrieve\n`version.number`.",
"minorEdit" : "If `minorEdit` is set to 'true', no notification email or activity\nstream will be generated for the change."
}
}

update_property_for_space

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

Permissions required:
‘Admin’ permission for the space.

Parameters

key (required)

The key of the property to be updated.

Type: string

spaceKey (required)

The key of the space that the property is in.

Type: string

$body

The space property being updated.

Type: object

{
"value" : { },
"version" : {
"number" : "The new version for the updated space property. Set this to the\ncurrent version number incremented by one. To get the current\nversion number, use 'Get space property' and retrieve\n`version.number`.",
"minorEdit" : "If `minorEdit` is set to 'true', no notification email or activity\nstream will be generated for the change."
}
}

update_restrictions

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.

Parameters

id (required)

The ID of the content to update restrictions for.

Type: string

$body

The updated restrictions for the content.

Type: array

[ {
"restrictions" : {
"user" : [ {
"accountId" : "The account ID of the user, which uniquely identifies the user across all Atlassian products.\nFor example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`. Required, unless `username` or `userKey` is specified.",
"type" : "Set to 'known'.",
"userKey" : "This property has been deprecated due to privacy changes. Use `accountId` instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe user key of the user. Required, unless `accountId` or `username` is specified.",
"username" : "This property has been deprecated due to privacy changes. Use `accountId` instead. See the\n[migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)\nfor details.\n\nThe username of the user. For example, _admin_. Required, unless `accountId` or `userKey` is specified."
} ],
"group" : [ {
"name" : "The name of the group.",
"type" : "Set to 'group'."
} ]
},
"operation" : "The restriction operation applied to content."
} ]

expand

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.

Type: array

[ "string. Possible values: restrictions.user | restrictions.group | content" ]

update_settings_for_space

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

Permissions required:
'Admin' permission for the space.

Parameters

spaceKey (required)

The key of the space whose settings will be updated.

Type: string

$body

The space settings to update.

Type: object

{
"routeOverrideEnabled" : "Defines whether an override for the space home should be used. This is\nused in conjunction with a space theme provided by an app. For\nexample, if this property is set to true, a theme can display a page\nother than the space homepage when users visit the root URL for a\nspace. This property allows apps to provide content-only theming\nwithout overriding the space home."
}

update_space

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.

Parameters

spaceKey (required)

The key of the space to update.

Type: string

$body

The updated space.

Type: object

{
"name" : "The name of the space.",
"description" : {
"plain" : {
"value" : "The space description.",
"representation" : "Set to 'plain'."
}
},
"homepage" : {
"id" : "The ID of the page."
}
}