{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Content Labels API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Content Labels",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Get Labels For Content",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/label",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content to be queried for its labels."
},
{
"name": "prefix",
"value": "",
"type": "query",
"description": "Filters the results to labels with the specified prefix. If this parameter\nis not specified, then labels with any prefix will be returned.\n\n- `global` prefix is used by default when a user adds a label\nvia the UI.\n- `my` prefix can be explicitly added by a user when adding a label\nvia the UI, e.g. 'my:example-label'. Also, when a page is selected as\na favourite, the 'my:favourite' label is automatically added.\n- `team` can used when adding labels via [Add labels to content](#api-content-id-label-post)\nbut is not used in the UI."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "The starting index of the returned labels."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of labels to return per page. Note,\nthis may be restricted by fixed system limits."
}
]
},
"docs": "Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
Returns the labels on a piece of content.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
'View' permission for the space and permission to view the content if it is a page."
},
{
"info": {
"name": "Atlassian Add Labels To Content",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/label",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that will have labels added to it."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds labels to a piece of content. Does not modify the existing labels.
Notes:
- Labels can also be added when creating content ([Create content](#api-content-post)).
- Labels can be updated when updating content ([Update content](#api-content-id-put)).
This will delete the existing labels and replace them with the labels in
the request.
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to update the content."
},
{
"info": {
"name": "Atlassian Remove Label From Content Using Query Parameter",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/label",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the label will be removed from."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "The name of the label to be removed."
}
]
},
"docs": "Removes a label from a piece of content. Labels can't be deleted from archived content.
This is similar to [Remove label from content](#api-content-id-label-label-delete)
except that the label name is specified via a query parameter.
Use this method if the label name has \"/\" characters, as
[Remove label from content using query parameter](#api-content-id-label-delete)
does not accept \"/\" characters for the label name.
**[Permissions](https://confluence.atlassian.com/x/_"
},
{
"info": {
"name": "Atlassian Remove Label From Content",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/wiki/rest/api/content/:id/label/:label",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the content that the label will be removed from."
},
{
"name": "label",
"value": "",
"type": "path",
"description": "The name of the label to be removed."
}
]
},
"docs": "Removes a label from a piece of content. Labels can't be deleted from archived content.
This is similar to [Remove label from content using query parameter](#api-content-id-label-delete)
except that the label name is specified via a path parameter.
Use this method if the label name does not have \"/\" characters, as the path
parameter does not accept \"/\" characters for security reasons. Otherwise,
use [Remove label from content using query parameter](#api-content-id-label-delete"
}
]
}
],
"bundled": true
}