Returns a paginated list of labels matching the given label name, namespace, space (via space key) or owner. Leave query params empty to ignore.
Example request URI(s):
http://example.com/confluence/rest/api/label/labels?spaceKey=MYS&namespace=global&limit=3
Forge and OAuth2 apps cannot access this REST resource.
string
string
string
string
string
string
Return a list of labels matching the given request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/label/labels' \
--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
{
"totalCount": 2154,
"results": [
{
"prefix": "my",
"name": "label",
"id": "1234",
"label": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"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"
}
}Returns a paginated list of the most popular labels within a Confluence instance. This includes Labels used by Pages, Blog Posts, and other Content types. Labels are sorted based on number of occurrences from the most to the least used. Only global labels are considered in this list.
Example request URI's:
https://example.com/confluence/rest/api/label/popular
https://example.com/confluence/rest/api/label/popular?start=2&limit=1
Forge and OAuth2 apps cannot access this REST resource.
string
string
a JSON representation of a list of labels, or an empty list if no labels are found.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/label/popular' \
--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
{
"totalCount": 2154,
"results": [
{
"prefix": "my",
"name": "label",
"id": "1234",
"label": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"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"
}
}Returns a paginated list of recently used labels within a Confluence instance. Labels are sorted from the most to the least recently used. Only global labels are considered in this list.
Example request URI's:
https://example.com/confluence/rest/api/label/recent
https://example.com/confluence/rest/api/label/recent?start=2&limit=1
Forge and OAuth2 apps cannot access this REST resource.
string
string
a JSON representation of a list of labels, or an empty list if no labels are found.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/label/recent' \
--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
{
"totalCount": 2154,
"results": [
{
"prefix": "my",
"name": "label",
"id": "1234",
"label": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"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"
}
}Return a paginated list of labels related to the given label name sorted by frequency of use in descending order. The current process for identifying related labels solely examines global labels, but it may change in the future.
Example request URI's:
https://example.com/confluence/rest/api/label/test_label_name/related
https://example.com/confluence/rest/api/label/my:test_label_name/related?limit=200
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
Return a JSON representation of related labels to the given label name
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/label/{labelName}/related' \
--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
{
"totalCount": 2154,
"results": [
{
"prefix": "my",
"name": "label",
"id": "1234",
"label": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"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"
}
}Rate this page: