• 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 Property
  • Space Watchers
  • SpaceColorScheme
  • User
  • User Group
  • User Watch
  • Webhooks
  • Other operations
Server
Confluence Data Center / / REST API

Space

Postman Collection
OpenAPI
Operations
PUT/rest/api/space/{spaceKey}/archiveGET/rest/api/space/{spaceKey}/contentGET/rest/api/space/{spaceKey}/content/{type}POST/rest/api/space/_privateGET/rest/api/spacePOST/rest/api/spaceGET/rest/api/space/{spaceKey}PUT/rest/api/space/{spaceKey}DEL/rest/api/space/{spaceKey}PUT/rest/api/space/{spaceKey}/restore
PUT

Archive space

Archive the given Space identified by spaceKey. This method is idempotent i.e., if the Space is already archived then no action will be taken.

Request

Path parameters

spaceKey

string

Required

Responses

No Content if the Space is archived successfully or already has status 'ARCHIVED'.

PUT/rest/api/space/{spaceKey}/archive
1 2 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/archive'
GET

Get contents in space

Returns the content in this given space.

Example request URI:

http://example.com/confluence/rest/api/space/TEST/content?expand=history

Request

Path parameters

spaceKey

string

Required

Query parameters

expand

string

depth

string

limit

string

start

string

Responses

Returns a full JSON representation of a piece of content.

application/json

object
GET/rest/api/space/{spaceKey}/content
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/content' \ --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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 { "pageRequest": { "cursor": { "reverse": true, "cursorType": "SPACE" }, "limit": 2154, "start": 2154 }, "nextCursor": { "reverse": true, "cursorType": "SPACE" }, "prevCursor": { "reverse": true, "cursorType": "SPACE" }, "results": [ { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": { "webui": "https://www.example.com/display/SPACEKEY/My+Page" }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": {}, "description": {}, "homepage": {}, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": {} }, "history": { "previousVersion": {}, "nextVersion": {}, "lastUpdated": {}, "latest": true, "createdBy": {}, "createdDate": "2020-01-01T00:00:00Z", "contributors": {}, "lastUpdatedRef": {}, "nextVersionRef": {}, "previousVersionRef": {}, "contentParentRef": {} }, "version": { "by": {}, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": {}, "contentRef": {} }, "ancestors": [], "position": 1, "operations": [ { "operation": "read", "targetType": "page" } ], "children": {}, "descendants": {}, "body": {}, "metadata": { "key": "value" }, "extensions": { "key": "value" }, "restrictions": { "use": { "operation": "use", "restrictions": [] } }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} } } ], "start": 25, "limit": 25, "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" }
GET

Get contents by type

Returns the content in this given space with the given type.

Example request URI:

http://example.com/confluence/rest/api/space/TEST/content/page?expand=history

Request

Path parameters

spaceKey

string

Required
type

string

Required

Query parameters

expand

string

depth

string

limit

string

start

string

Responses

Returns a full JSON representation of a piece of content.

application/json

object
GET/rest/api/space/{spaceKey}/content/{type}
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/content/{type}' \ --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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 { "pageRequest": { "cursor": { "reverse": true, "cursorType": "SPACE" }, "limit": 2154, "start": 2154 }, "nextCursor": { "reverse": true, "cursorType": "SPACE" }, "prevCursor": { "reverse": true, "cursorType": "SPACE" }, "results": [ { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": { "webui": "https://www.example.com/display/SPACEKEY/My+Page" }, "space": { "id": 123456, "key": "TEST", "name": "Test Space", "status": "current", "icon": {}, "description": {}, "homepage": {}, "links": {}, "type": "global", "metadata": { "labels": [ "label1", "label2" ] }, "retentionPolicy": {} }, "history": { "previousVersion": {}, "nextVersion": {}, "lastUpdated": {}, "latest": true, "createdBy": {}, "createdDate": "2020-01-01T00:00:00Z", "contributors": {}, "lastUpdatedRef": {}, "nextVersionRef": {}, "previousVersionRef": {}, "contentParentRef": {} }, "version": { "by": {}, "when": "2020-01-01T00:00:00Z", "message": "A message", "number": 1, "minorEdit": true, "hidden": true, "syncRev": "123456", "content": {}, "contentRef": {} }, "ancestors": [], "position": 1, "operations": [ { "operation": "read", "targetType": "page" } ], "children": {}, "descendants": {}, "body": {}, "metadata": { "key": "value" }, "extensions": { "key": "value" }, "restrictions": { "use": { "operation": "use", "restrictions": [] } }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} } } ], "start": 25, "limit": 25, "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "self": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=25", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" }
POST

Create private space

Creates a new private Space, viewable only by its creator. The incoming Space does not include an id, but must include a Key and Name, and should include a Description.

Request

Request bodyapplication/json

The space to be created

id

integer

key

string

name

string

status

string

icon

ReferenceIcon

description

object

homepage

ReferenceContent

links

object

type

string

metadata

object

Responses

Returns a full JSON representation of a space.

application/json

Space
POST/rest/api/space/_private
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 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/space/_private' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "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": {} } }'
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 { "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": {} } }
GET

Get spaces by key

Returns information about a number of spaces.

Example request URI(s):

http://example.com/confluence/rest/api/space?spaceKey=TST&spaceKey=ds

Request

Query parameters

spaceKeySingle

string

spaceKey

string

expand

string

hasRetentionPolicy

string

limit

string

start

string

label

string

favourite

string

type

string

status

string

Request bodyapplication/json

string

Responses

Returns an array of full JSON representations of found space.

application/json

Space
GET/rest/api/space
1 2 3 4 5 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '"<string>"'
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 { "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": {} } }
POST

Creates a new Space.

Creates a new Space. The incoming Space does not include an id, but must include a Key and Name, and should include a Description.

Request

Request bodyapplication/json

The space to be created

id

integer

key

string

name

string

status

string

icon

ReferenceIcon

description

object

homepage

ReferenceContent

links

object

type

string

metadata

object

Responses

Returns a full JSON representation of a space.

application/json

Space
POST/rest/api/space
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 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/space' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "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": {} } }'
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 { "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": {} } }
GET

Get space

Returns information about a space.

Example request URI:

http://example.com/confluence/rest/api/space/TST?expand=description

Request

Path parameters

spaceKey

string

Required

Query parameters

expand

string

Responses

Returns a full JSON representation of a space.

application/json

Space
GET/rest/api/space/{spaceKey}
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}' \ --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 { "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": {} } }
PUT

Update Space

Updates a Space. The incoming Space must include a Key and Name, and should include a Description

Request

Path parameters

spaceKey

string

Required

Request bodyapplication/json

the space being updated

id

integer

key

string

name

string

status

string

icon

ReferenceIcon

description

object

homepage

ReferenceContent

links

object

type

string

metadata

object

Responses

Returns a full JSON representation of a space.

application/json

Space
PUT/rest/api/space/{spaceKey}
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 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "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": {} } }'
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 { "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": {} } }
DEL

Delete Space

Deletes a Space. The space is deleted in a long running task, so the space cannot be considered deleted when this resource returns. Clients can follow the status link in the response and poll it until the task completes.

Request

Path parameters

spaceKey

string

Required

Responses

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

application/json

LongTaskSubmission
DEL/rest/api/space/{spaceKey}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}' \ --header 'Accept: application/json'
202Response
1 2 3 4 5 6 7 8 9 { "id": "<string>", "links": { "result": "http://localhost:8080/confluence/rest/api/longtask/123/result", "status": "http://localhost:8080/confluence/rest/api/longtask/123/status" }, "resultPath": "result", "statusPath": "status" }
PUT

Restore space

Restore the given Space identified by spaceKey. This method is idempotent i.e., if the Space is already restored then no action will be taken.

Request

Path parameters

spaceKey

string

Required

Responses

No Content if the Space is restored successfully or already has status 'CURRENT'.

PUT/rest/api/space/{spaceKey}/restore
1 2 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/restore'

Rate this page: