Rate this page:
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.
App scope required: READ
read:confluence-props
string
The key of the space to be queried for its properties.
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.form
Valid values: version
, space
integer
The starting index of the returned objects.
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/space/{spaceKey}/property' \
--header 'Accept: application/json'
Returned if the requested space properties are returned.
Content type | Value |
---|---|
application/json |
POST /wiki/rest/api/space/{spaceKey}/property
Creates a new space property.
Permissions required: ‘Admin’ permission for the space.
App scope required: WRITE
write:confluence-props
string
The key of the space that the property will be created in.
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/space/{spaceKey}/property' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"key": "<string>",
"value": {}
}'
Returned if the space property is created.
Content type | Value |
---|---|
application/json |
GET /wiki/rest/api/space/{spaceKey}/property/{key}
Returns a space property.
Permissions required: ‘View’ permission for the space.
App scope required: READ
read:confluence-props
string
The key of the space that the property is in.
string
The key of the space property.
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.form
Valid values: version
, space
1 2 3
curl --request GET \
--url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}' \
--header 'Accept: application/json'
Returned if the requested space property is returned.
Content type | Value |
---|---|
application/json |
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.
App scope required: WRITE
write:confluence-props
string
The key of the space that the property is in.
string
The key of the property to be updated.
1 2 3 4 5 6 7 8 9 10 11
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
}
}'
Returned if the space property is updated.
Content type | Value |
---|---|
application/json |
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.
App scope required: WRITE
write:confluence-props
string
The key of the space that the property will be created in.
string
The key of the property to be created.
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/space/{spaceKey}/property/{key}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"value": {}
}'
Returned if the space property is created.
Content type | Value |
---|---|
application/json |
DELETE /wiki/rest/api/space/{spaceKey}/property/{key}
Deletes a space property.
Permissions required: ‘Admin’ permission for the space.
App scope required: DELETE
write:confluence-props
string
The key of the space that the property is in.
string
The key of the property to be deleted.
1 2
curl --request DELETE \
--url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/property/{key}'
Returned if the space property is deleted.
Rate this page: