Rate this page:
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.
App scope required: READ
read:confluence-props
string
The ID of the content to be queried for its properties.
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.form
Valid values: content
, version
integer
The starting index of the returned properties.
0
, Minimum: 0
, Format: int32
integer
The maximum number of properties to return per page. Note, this may be restricted by fixed system limits.
10
, Minimum: 0
, Format: int32
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property' \
--header 'Accept: application/json'
Returned if the requested properties are returned.
Content type | Value |
---|---|
application/json |
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.
App scope required: WRITE
write:confluence-props
string
The ID of the content to add the property to.
string
The key of the new property.
255
The value of the property. This can be empty or a complex object. For example,
1 2 3 4 5
"value": {
"example1": "value",
"example2": true,
"example3": 123
}
1 2 3 4 5 6 7 8
curl --request POST \
--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"value": {}
}'
Returned if the content property is created.
Content type | Value |
---|---|
application/json |
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.
App scope required: READ
read:confluence-props
string
The ID of the content to be queried for the property.
string
The key of the content property.
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.form
Valid values: content
, version
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}' \
--header 'Accept: application/json'
Returned if the content property is returned.
Content type | Value |
---|---|
application/json |
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.
App scope required: WRITE
write:confluence-props
string
The ID of the content that the property belongs to.
string
The key of the property.
1 2 3 4 5 6 7 8 9 10 11
curl --request PUT \
--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"value": {},
"version": {
"number": 201,
"minorEdit": true
}
}'
Returned if the content property is created.
Content type | Value |
---|---|
application/json |
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.
App scope required: WRITE
write:confluence-props
string
The ID of the content to add the property to.
string
The key of the content property. Required.
The value of the property. This can be empty or a complex object. For example,
1 2 3 4 5
"value": {
"example1": "value",
"example2": true,
"example3": 123
}
1 2 3 4 5 6 7
curl --request POST \
--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"value": {}
}'
Returned if the content property is created.
Content type | Value |
---|---|
application/json |
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.
App scope required: DELETE
write:confluence-props
string
The ID of the content that the property belongs to.
string
The key of the property.
1 2
curl --request DELETE \
--url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/property/{key}'
Returned if the content property is deleted.
Rate this page: