• Access Mode
  • Admin Group
  • Admin User
  • Attachments
  • Backup and Restore
  • Category
  • Child Content
  • Content Blueprint
  • Content Body
  • Content Descendant
  • Content Labels
  • Content Property
  • Content Resource
  • Content Restrictions
  • Content Version
  • Content Watchers
  • GlobalColorScheme
  • Group
  • Instance Metrics
  • Label
  • Long Task
  • Search
  • Server Information
  • Space
  • Space Label
  • Space Permissions
  • Space Property
  • Space Watchers
  • SpaceColorScheme
  • User
  • User Group
  • User Watch
  • Webhooks
  • Other operations
Server
Confluence Data Center / / REST API

Space Property

Postman Collection
OpenAPI
Operations
GET/rest/api/space/{spaceKey}/propertyPOST/rest/api/space/{spaceKey}/propertyGET/rest/api/space/{spaceKey}/property/{key}PUT/rest/api/space/{spaceKey}/property/{key}POST/rest/api/space/{spaceKey}/property/{key}DEL/rest/api/space/{spaceKey}/property/{key}
GET

Get space properties

Returns a paginated list of space properties.

Example request URI:

http://example.com/confluence/rest/api/space/TST/property?expand=space,version

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

spaceKey

string

Required

Query parameters

expand

string

limit

string

start

string

Responses

a JSON representation of the space properties.

application/json

object
GET/rest/api/space/{spaceKey}/property
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 { "results": [ { "key": "<string>", "value": { "value": "<string>" }, "version": { "by": {}, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": {}, "contentRef": {} }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": {}, "description": {}, "homepage": {}, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": {} }, "spaceRef": { "expanded": true, "idProperties": {} } } ], "start": 25, "limit": 25, "size": 25, "_links": { "base": "http://localhost:8085/rest/api", "self": "http://localhost:8085/rest/api", "context": "http://localhost:8085/rest/api", "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" } }
POST

Create a space property

Creates a new space property.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

spaceKey

string

Required

Request bodyapplication/json

space property to be created

key

string

value

JsonString

version

Version

space

Space

spaceRef

ReferenceSpace

Responses

Returns a full JSON representation of the space property.

application/json

JsonSpaceProperty
POST/rest/api/space/{spaceKey}/property
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "key": "<string>", "value": { "value": "<string>" }, "version": { "by": { "profilePicture": {}, "displayName": "Joe Smith", "type": "<string>" }, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": { "expanded": true, "idProperties": {} }, "contentRef": { "expanded": true, "idProperties": {} } }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": { "expanded": true, "idProperties": {} }, "description": {}, "homepage": { "expanded": true, "idProperties": {} }, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": { "expanded": true, "idProperties": {} } }, "spaceRef": { "expanded": true, "idProperties": {} } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 { "key": "<string>", "value": { "value": "<string>" }, "version": { "by": { "profilePicture": {}, "displayName": "Joe Smith", "type": "<string>" }, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": { "expanded": true, "idProperties": {} }, "contentRef": { "expanded": true, "idProperties": {} } }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": { "expanded": true, "idProperties": {} }, "description": {}, "homepage": { "expanded": true, "idProperties": {} }, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": { "expanded": true, "idProperties": {} } }, "spaceRef": { "expanded": true, "idProperties": {} } }
GET

Get space property by key

Returns a space property.

Example request URI:

http://example.com/confluence/rest/api/space/TST/property/example-property-key?expand=space,version

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

spaceKey

string

Required
key

string

Required

Query parameters

expand

string

limit

string

start

string

Responses

Returns a full JSON representation of the space property.

application/json

JsonSpaceProperty
GET/rest/api/space/{spaceKey}/property/{key}
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property/{key}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 { "key": "<string>", "value": { "value": "<string>" }, "version": { "by": { "profilePicture": {}, "displayName": "Joe Smith", "type": "<string>" }, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": { "expanded": true, "idProperties": {} }, "contentRef": { "expanded": true, "idProperties": {} } }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": { "expanded": true, "idProperties": {} }, "description": {}, "homepage": { "expanded": true, "idProperties": {} }, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": { "expanded": true, "idProperties": {} } }, "spaceRef": { "expanded": true, "idProperties": {} } }
PUT

Update space property

Updates a space property.The body contains the representation of the space property. Must include new version number.If the given version number is 1, attempts to create a new space property.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

spaceKey

string

Required
key

string

Required

Request bodyapplication/json

space property to be updated

key

string

value

JsonString

version

Version

space

Space

spaceRef

ReferenceSpace

Responses

Returns a full JSON representation of the property.

application/json

JsonSpaceProperty
PUT/rest/api/space/{spaceKey}/property/{key}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property/{key}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "key": "<string>", "value": { "value": "<string>" }, "version": { "by": { "profilePicture": {}, "displayName": "Joe Smith", "type": "<string>" }, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": { "expanded": true, "idProperties": {} }, "contentRef": { "expanded": true, "idProperties": {} } }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": { "expanded": true, "idProperties": {} }, "description": {}, "homepage": { "expanded": true, "idProperties": {} }, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": { "expanded": true, "idProperties": {} } }, "spaceRef": { "expanded": true, "idProperties": {} } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 { "key": "<string>", "value": { "value": "<string>" }, "version": { "by": { "profilePicture": {}, "displayName": "Joe Smith", "type": "<string>" }, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": { "expanded": true, "idProperties": {} }, "contentRef": { "expanded": true, "idProperties": {} } }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": { "expanded": true, "idProperties": {} }, "description": {}, "homepage": { "expanded": true, "idProperties": {} }, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": { "expanded": true, "idProperties": {} } }, "spaceRef": { "expanded": true, "idProperties": {} } }
POST

Create a space property with a specific key

Create a space property with a specific key.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

spaceKey

string

Required
key

string

Required

Request bodyapplication/json

space property to be created

key

string

value

JsonString

version

Version

space

Space

spaceRef

ReferenceSpace

Responses

Returns a full JSON representation of the space property.

application/json

JsonSpaceProperty
POST/rest/api/space/{spaceKey}/property/{key}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property/{key}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "key": "<string>", "value": { "value": "<string>" }, "version": { "by": { "profilePicture": {}, "displayName": "Joe Smith", "type": "<string>" }, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": { "expanded": true, "idProperties": {} }, "contentRef": { "expanded": true, "idProperties": {} } }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": { "expanded": true, "idProperties": {} }, "description": {}, "homepage": { "expanded": true, "idProperties": {} }, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": { "expanded": true, "idProperties": {} } }, "spaceRef": { "expanded": true, "idProperties": {} } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 { "key": "<string>", "value": { "value": "<string>" }, "version": { "by": { "profilePicture": {}, "displayName": "Joe Smith", "type": "<string>" }, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": { "expanded": true, "idProperties": {} }, "contentRef": { "expanded": true, "idProperties": {} } }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": { "expanded": true, "idProperties": {} }, "description": {}, "homepage": { "expanded": true, "idProperties": {} }, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": { "expanded": true, "idProperties": {} } }, "spaceRef": { "expanded": true, "idProperties": {} } }
DEL

Delete space property

Deletes a space property.

Example request URI:

http://example.com/confluence/rest/api/space/TST/property/example-property-key?expand=space,version

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

spaceKey

string

Required
key

string

Required

Responses

Returned if successfully deleted.

DEL/rest/api/space/{spaceKey}/property/{key}
1 2 curl --request DELETE \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property/{key}'

Rate this page: