Returns a paginated list of space properties.
Example request URI:
http://example.com/confluence/rest/api/space/TST/property?expand=space,version
string
Requiredstring
string
string
a JSON representation of the space properties.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property' \
--header 'Accept: application/json'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
{
"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",
"creator": {},
"creationDate": "2024-01-01T00:00:00Z",
"lastModifier": {},
"lastModificationDate": "2024-01-01T00:00:00Z",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {},
"permissions": {}
},
"spaceRef": {
"idProperties": {},
"expanded": true
},
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"totalCount": 2154,
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Creates a new space property.
string
Requiredspace property to be created
string
JsonString
Version
Space
ReferenceSpace
object
object
Returns a full JSON representation of the space 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
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": {
"idProperties": {},
"expanded": true
},
"contentRef": {
"idProperties": {},
"expanded": true
}
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {
"idProperties": {},
"expanded": true
},
"description": {},
"homepage": {
"idProperties": {},
"expanded": true
},
"links": {},
"type": "global",
"creator": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"creationDate": "2024-01-01T00:00:00Z",
"lastModifier": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"lastModificationDate": "2024-01-01T00:00:00Z",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {
"idProperties": {},
"expanded": true
},
"permissions": {
"idProperties": {},
"expanded": true
}
},
"spaceRef": {
"idProperties": {},
"expanded": true
},
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}'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
{
"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": {
"idProperties": {},
"expanded": true
},
"contentRef": {
"idProperties": {},
"expanded": true
}
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {
"idProperties": {},
"expanded": true
},
"description": {},
"homepage": {
"idProperties": {},
"expanded": true
},
"links": {},
"type": "global",
"creator": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"creationDate": "2024-01-01T00:00:00Z",
"lastModifier": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"lastModificationDate": "2024-01-01T00:00:00Z",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {
"idProperties": {},
"expanded": true
},
"permissions": {
"idProperties": {},
"expanded": true
}
},
"spaceRef": {
"idProperties": {},
"expanded": true
},
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}Returns a space property.
Example request URI:
http://example.com/confluence/rest/api/space/TST/property/example-property-key?expand=space,version
string
Requiredstring
Requiredstring
string
string
Returns a full JSON representation of the space property.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property/{key}' \
--header 'Accept: application/json'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
{
"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": {
"idProperties": {},
"expanded": true
},
"contentRef": {
"idProperties": {},
"expanded": true
}
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {
"idProperties": {},
"expanded": true
},
"description": {},
"homepage": {
"idProperties": {},
"expanded": true
},
"links": {},
"type": "global",
"creator": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"creationDate": "2024-01-01T00:00:00Z",
"lastModifier": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"lastModificationDate": "2024-01-01T00:00:00Z",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {
"idProperties": {},
"expanded": true
},
"permissions": {
"idProperties": {},
"expanded": true
}
},
"spaceRef": {
"idProperties": {},
"expanded": true
},
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}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.
string
Requiredstring
Requiredspace property to be updated
string
JsonString
Version
Space
ReferenceSpace
object
object
Returns a full JSON representation of the 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
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": {
"idProperties": {},
"expanded": true
},
"contentRef": {
"idProperties": {},
"expanded": true
}
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {
"idProperties": {},
"expanded": true
},
"description": {},
"homepage": {
"idProperties": {},
"expanded": true
},
"links": {},
"type": "global",
"creator": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"creationDate": "2024-01-01T00:00:00Z",
"lastModifier": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"lastModificationDate": "2024-01-01T00:00:00Z",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {
"idProperties": {},
"expanded": true
},
"permissions": {
"idProperties": {},
"expanded": true
}
},
"spaceRef": {
"idProperties": {},
"expanded": true
},
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}'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
{
"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": {
"idProperties": {},
"expanded": true
},
"contentRef": {
"idProperties": {},
"expanded": true
}
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {
"idProperties": {},
"expanded": true
},
"description": {},
"homepage": {
"idProperties": {},
"expanded": true
},
"links": {},
"type": "global",
"creator": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"creationDate": "2024-01-01T00:00:00Z",
"lastModifier": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"lastModificationDate": "2024-01-01T00:00:00Z",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {
"idProperties": {},
"expanded": true
},
"permissions": {
"idProperties": {},
"expanded": true
}
},
"spaceRef": {
"idProperties": {},
"expanded": true
},
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}Create a space property with a specific key.
string
Requiredstring
Requiredspace property to be created
string
JsonString
Version
Space
ReferenceSpace
object
object
Returns a full JSON representation of the space 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
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": {
"idProperties": {},
"expanded": true
},
"contentRef": {
"idProperties": {},
"expanded": true
}
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {
"idProperties": {},
"expanded": true
},
"description": {},
"homepage": {
"idProperties": {},
"expanded": true
},
"links": {},
"type": "global",
"creator": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"creationDate": "2024-01-01T00:00:00Z",
"lastModifier": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"lastModificationDate": "2024-01-01T00:00:00Z",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {
"idProperties": {},
"expanded": true
},
"permissions": {
"idProperties": {},
"expanded": true
}
},
"spaceRef": {
"idProperties": {},
"expanded": true
},
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}'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
{
"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": {
"idProperties": {},
"expanded": true
},
"contentRef": {
"idProperties": {},
"expanded": true
}
},
"space": {
"id": 123456,
"key": "TEST",
"name": "Test Space",
"status": "current",
"icon": {
"idProperties": {},
"expanded": true
},
"description": {},
"homepage": {
"idProperties": {},
"expanded": true
},
"links": {},
"type": "global",
"creator": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"creationDate": "2024-01-01T00:00:00Z",
"lastModifier": {
"profilePicture": {},
"displayName": "Joe Smith",
"type": "<string>"
},
"lastModificationDate": "2024-01-01T00:00:00Z",
"metadata": {
"labels": [
"label1",
"label2"
]
},
"retentionPolicy": {
"idProperties": {},
"expanded": true
},
"permissions": {
"idProperties": {},
"expanded": true
}
},
"spaceRef": {
"idProperties": {},
"expanded": true
},
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}Deletes a space property.
Example request URI:
http://example.com/confluence/rest/api/space/TST/property/example-property-key?expand=space,version
string
Requiredstring
RequiredReturned if successfully deleted.
1
2
curl --request DELETE \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/property/{key}'Rate this page: