• 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

Content Property

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

Find all content properties

Returns a paginated list of content properties. Example request URI(s):

  • http://example.com/confluence/rest/api/content/1234/property?expand=content,version

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Query parameters

expand

string

limit

string

start

string

Responses

returns a JSON representation of the content properties, or a 404 NOT FOUND if there is no content with the given id or if the user is not permitted..

application/json

object
GET/rest/api/content/{id}/property
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/content/{id}/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 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 { "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": {} }, "id": "<string>", "content": { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "space": {}, "history": {}, "version": {}, "ancestors": [], "position": 1, "operations": [ {} ], "children": {}, "descendants": {}, "body": {}, "metadata": { "key": "value" }, "extensions": { "key": "value" }, "restrictions": { "use": { "operation": "use", "restrictions": [] } }, "containerRef": {}, "versionRef": {}, "historyRef": {}, "spaceRef": {} }, "contentRef": { "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 content property

Creates a new content property.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required

Request bodyapplication/json

content property to be created.

key

string

value

JsonString

version

Version

id

string

content

Content

contentRef

ReferenceContent

Responses

Returns a full JSON representation of the content property.

application/json

JsonContentProperty
POST/rest/api/content/{id}/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 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 116 117 118 119 120 121 122 123 124 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/content/{id}/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": {} } }, "id": "<string>", "content": { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "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": [] } }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} } }, "contentRef": { "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 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 116 117 118 119 120 { "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": {} } }, "id": "<string>", "content": { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "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": [] } }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} } }, "contentRef": { "expanded": true, "idProperties": {} } }
GET

Find content property by key

Returns a content property. Example request URI(s):

  • http://example.com/confluence/rest/api/content/1234/property/example-property-key?expand=content,version

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required
key

string

Required

Query parameters

expand

string

limit

string

Responses

returns a JSON representation of the content property.

application/json

JsonContentProperty
GET/rest/api/content/{id}/property/{key}
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/content/{id}/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 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 116 117 118 119 120 { "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": {} } }, "id": "<string>", "content": { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "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": [] } }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} } }, "contentRef": { "expanded": true, "idProperties": {} } }
PUT

Update content property

Updates a content property. The body contains the representation of the content property. Must include the property id, and the new version number. Attempts to create a new content property if the given version number is 1

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required
key

string

Required

Query parameters

expand

string

Request bodyapplication/json

the content property being updated

key

string

value

JsonString

version

Version

id

string

content

Content

contentRef

ReferenceContent

Responses

returns a JSON representation of the content property, or a 404 NOT FOUND if there is no content with the given id, or no property with the given key, or if the user is not permitted.

application/json

JsonContentProperty
PUT/rest/api/content/{id}/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 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 116 117 118 119 120 121 122 123 124 curl --request PUT \ --url 'http://{baseurl}/confluence/rest/api/content/{id}/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": {} } }, "id": "<string>", "content": { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "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": [] } }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} } }, "contentRef": { "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 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 116 117 118 119 120 { "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": {} } }, "id": "<string>", "content": { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "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": [] } }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} } }, "contentRef": { "expanded": true, "idProperties": {} } }
POST

Post rest api content {id} property {key}

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required
key

string

Required

Request bodyapplication/json

key

string

value

JsonString

version

Version

id

string

content

Content

contentRef

ReferenceContent

Responses

default response

application/json

JsonContentProperty
POST/rest/api/content/{id}/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 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 116 117 118 119 120 121 122 123 curl --request POST \ --url 'http://{baseurl}/confluence/rest/api/content/{id}/property/{key}' \ --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": {} } }, "id": "<string>", "content": { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "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": [] } }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} } }, "contentRef": { "expanded": true, "idProperties": {} } }'
defaultResponse
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 116 117 118 119 120 { "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": {} } }, "id": "<string>", "content": { "id": "123456", "type": "page", "status": "current", "title": "My Page", "links": {}, "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": [] } }, "containerRef": { "expanded": true, "idProperties": {} }, "versionRef": { "expanded": true, "idProperties": {} }, "historyRef": { "expanded": true, "idProperties": {} }, "spaceRef": { "expanded": true, "idProperties": {} } }, "contentRef": { "expanded": true, "idProperties": {} } }
DEL

Delete content property

Deletes a content property.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

string

Required
key

string

Required

Responses

Returned if successfully deleted.

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

Rate this page: