The Confluence Cloud REST API

Space properties

Get space properties

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

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

Permissions required: ‘View’ permission for the space.

Connect app scope required: READ

OAuth scopes required:

read:confluence-props

Request

Path parameters

spaceKey Required

string

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

Query parameters

expand

Array<string>

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

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

Style: form

Valid values: version, space

start

integer

The starting index of the returned objects.

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

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property' \
  --header 'Accept: application/json'

Responses

200

404

Returned if the requested space properties are returned.

Content type	Value
application/json	SpacePropertyArray

Create space property

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

Creates a new space property.

Permissions required: ‘Admin’ permission for the space.

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-props

Request

Path parameters

spaceKey Required

string

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

Body parameters

key Required

string

The key of the new property.

Maximum: 255

value Required

PropertyValue

The value of the property. This can be empty or a complex object. For example,

"value": {
  "example1": "value",
  "example2": true,
  "example3": 123
}

Example

cURL

Node.js

Java

Python

PHP

Forge

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

Responses

200

400

403

413

Returned if the space property is created.

Content type	Value
application/json	SpaceProperty

Get space property

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

Returns a space property.

Permissions required: ‘View’ permission for the space.

Connect app scope required: READ

OAuth scopes required:

read:confluence-props

Request

Path parameters

spaceKey Required

string

The key of the space that the property is in.

key Required

string

The key of the space property.

Query parameters

expand

Array<string>

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

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

Style: form

Valid values: version, space

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}' \
  --header 'Accept: application/json'

Responses

200

404

Returned if the requested space property is returned.

Content type	Value
application/json	SpaceProperty

Update space property

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

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

Permissions required: ‘Admin’ permission for the space.

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-props

Request

Path parameters

spaceKey Required

string

The key of the space that the property is in.

key Required

string

The key of the property to be updated.

Body parameters

value Required

object

The value of the property.

version Required

object

The version number of the property.

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request PUT \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "value": {},
  "version": {
    "number": 197,
    "minorEdit": true
  }
}'

Responses

200

400

403

404

409

413

Returned if the space property is updated.

Content type	Value
application/json	SpaceProperty

Create space property for key

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

Creates a new space property. This is the same as POST /api/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.

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-props

Request

Path parameters

spaceKey Required

string

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

key Required

string

The key of the property to be created.

Body parameters

value Required

PropertyValue

The value of the property. This can be empty or a complex object. For example,

"value": {
  "example1": "value",
  "example2": true,
  "example3": 123
}

Example

cURL

Node.js

Java

Python

PHP

Forge

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

Responses

200

400

403

413

Returned if the space property is created.

Content type	Value
application/json	SpaceProperty

Delete space property

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

Deletes a space property.

Permissions required: ‘Admin’ permission for the space.

Connect app scope required: DELETE

OAuth scopes required:

write:confluence-props

Request

Path parameters

spaceKey Required

string

The key of the space that the property is in.

key Required

string

The key of the property to be deleted.

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}'

Responses

204

404

Returned if the space property is deleted.