The Confluence Cloud REST API

Content properties

Get content properties

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

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

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

Connect app scope required: READ

OAuth scopes required:

read:confluence-props

Request

Path parameters

id Required

string

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

Query parameters

key

Array<string>

The key of the content property.

expand

Array<string>

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

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

Style: form

Valid values: content, version

start

integer

The starting index of the returned properties.

Default: 0, Minimum: 0, Format: int32

limit

integer

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

Default: 10, Minimum: 0, Format: int32

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

404

Returned if the requested properties are returned.

Content type	Value
application/json	ContentPropertyArray

Create content property

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

Creates a property for an existing piece of content. For more information about content properties, see 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.

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-props

Request

Path parameters

id Required

string

The ID of the content to add the property to.

Body parameters

key Required

string

The key of the new property.

Max length: 255

value Required

oneOf [Array<string>, boolean, object, string]

The value of the content property. This can be empty or a complex object.

Additional Properties

anything

Extra properties of any type may be provided to this object.

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request POST \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "<string>",
  "value": [
    "<string>"
  ]
}'

Responses

200

400

403

413

Returned if the content property is created.

Content type	Value
application/json	ContentProperty

Get content property

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

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.

Connect app scope required: READ

OAuth scopes required:

read:confluence-props

Request

Path parameters

id Required

string

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

key Required

string

The key of the content property.

Query parameters

expand

Array<string>

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

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

Style: form

Valid values: content, version

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

200

404

Returned if the content property is returned.

Content type	Value
application/json	ContentProperty

Update content property

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

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

Permissions required: Permission to update the content.

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-props

Request

Path parameters

id Required

string

The ID of the content that the property belongs to.

key Required

string

The key of the property.

Body parameters

value Required

oneOf [Array<string>, boolean, object, string]

The value of the content property. This can be empty or a complex object.

version Required

object

The version number of the property.

Nullable: true

Additional Properties

anything

Extra properties of any type may be provided to this object.

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request PUT \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": [
    "<string>"
  ],
  "version": {
    "number": 201,
    "minorEdit": true
  }
}'

Responses

200

400

403

404

409

413

Returned if the content property is created.

Content type	Value
application/json	ContentProperty

Create content property for key

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

Creates a property for an existing piece of content. For more information about content properties, see 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.

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-props

Request

Path parameters

id Required

string

The ID of the content to add the property to.

key Required

string

The key of the content property. Required.

Body parameters

value Required

oneOf [Array<string>, boolean, object, string]

The value of the content property. This can be empty or a complex object.

Additional Properties

anything

Extra properties of any type may be provided to this object.

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request POST \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": [
    "<string>"
  ]
}'

Responses

200

400

403

413

Returned if the content property is created.

Content type	Value
application/json	ContentProperty

Delete content property

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

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

Permissions required: Permission to update the content.

Connect app scope required: DELETE

OAuth scopes required:

write:confluence-props

Request

Path parameters

id Required

string

The ID of the content that the property belongs to.

key Required

string

The key of the property.

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}' \
  --header 'Authorization: Bearer <access_token>'

Responses

204

403

404

Returned if the content property is deleted.

A schema has not been defined for this response code.