Skip to content

Update Tags API Documentation #33260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
+60 −48
Open

Update Tags API Documentation #33260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions config/_default/menus/api.en.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4192,7 +4192,7 @@ menu:
- CreateHostTags
unstable: []
order: 3
- name: Get host tags
- name: Get Host Tags
url: '#get-host-tags'
identifier: tags-get-host-tags
parent: tags
Expand All @@ -4216,9 +4216,9 @@ menu:
- DeleteHostTags
unstable: []
order: 5
- name: Get Tags
url: '#get-tags'
identifier: tags-get-tags
- name: Get All Host Tags
url: '#get-all-host-tags'
identifier: tags-get-all-host-tags
parent: tags
generated: true
params:
Expand Down
8 changes: 4 additions & 4 deletions content/en/api/v1/tags/examples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
]
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tags</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">&lt;any-key&gt;</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of additional properties for tags.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tags</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>A mapping of tags</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">&lt;any-key&gt;</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of host names which contain this tag</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
},
"403": {
"json": {
Expand Down Expand Up @@ -84,7 +84,7 @@
"environment:production"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"403": {
"json": {
Expand Down Expand Up @@ -126,7 +126,7 @@
"environment:production"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"403": {
"json": {
Expand Down Expand Up @@ -173,7 +173,7 @@
"environment:production"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags to apply to the host.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">host</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Your host name.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of tags attached to a given host.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"403": {
"json": {
Expand Down
82 changes: 47 additions & 35 deletions data/api/v1/full_spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4261,7 +4261,7 @@ components:
example: false
type: boolean
type: object
HostTags:
HostTagsInput:
description: Set of tags to associate with your host.
properties:
host:
Expand All @@ -4276,6 +4276,21 @@ components:
type: string
type: array
type: object
HostTagsOutput:
description: Set of tags to associate with your host.
properties:
host:
description: Your host name.
example: test.host
type: string
tags:
description: A list of tags attached to a given host.
items:
description: A given tag in a list.
example: environment:production
type: string
type: array
type: object
HostTotals:
description: Total number of host currently monitored by Datadog.
properties:
Expand Down Expand Up @@ -18900,18 +18915,18 @@ components:
- match
type: object
TagToHosts:
description: In this object, the key is the tag, the value is a list of host
names that are reporting that tag.
description: In this object, the key is the tag, and the value is a list of
host names that are reporting that tag.
properties:
tags:
additionalProperties:
description: A list of additional properties for tags.
description: A list of host names which contain this tag
items:
description: A given tag in a list.
example: test.metric.host
type: string
type: array
description: A list of tags to apply to the host.
description: A mapping of tags
type: object
type: object
TargetFormatType:
Expand Down Expand Up @@ -36781,11 +36796,13 @@ paths:
- synthetics_global_variable_write
/api/v1/tags/hosts:
get:
description: Return a mapping of tags to hosts for your whole infrastructure.
description: Returns a mapping of tags to hosts. For each tag, the response
returns a list of host names that contain this tag. There is a restriction
of 10k host names from the org that can be attached to tags and returned.
operationId: ListHostTags
parameters:
- description: When specified, filters host list to those tags with the specified
source.
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
Use "user" source for custom-defined tags.
in: query
name: source
required: false
Expand Down Expand Up @@ -36816,7 +36833,7 @@ paths:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
summary: Get Tags
summary: Get All Host Tags
tags:
- Tags
x-menu-order: 1
Expand All @@ -36830,16 +36847,14 @@ paths:
for a single host.'
operationId: DeleteHostTags
parameters:
- description: This endpoint allows you to remove all user-assigned tags for
a single host.
- description: Specified host name to delete tags
in: path
name: host_name
required: true
schema:
type: string
- description: 'The source of the tags (for example chef, puppet).

[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
Use "user" source for custom-defined tags.
in: query
name: source
required: false
Expand Down Expand Up @@ -36870,14 +36885,14 @@ paths:
description: Return the list of tags that apply to a given host.
operationId: GetHostTags
parameters:
- description: When specified, filters list of tags to those tags with the specified
source.
- description: Specified host name to view tags
in: path
name: host_name
required: true
schema:
type: string
- description: Source to filter.
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
Use "user" source for custom-defined tags.
in: query
name: source
required: false
Expand All @@ -36888,7 +36903,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/HostTags'
$ref: '#/components/schemas/HostTagsOutput'
description: OK
'403':
content:
Expand All @@ -36904,26 +36919,24 @@ paths:
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get host tags
summary: Get Host Tags
tags:
- Tags
x-menu-order: 2
post:
description: 'This endpoint allows you to add new tags to a host,

optionally specifying where these tags come from.'
optionally specifying what source these tags come from.'
operationId: CreateHostTags
parameters:
- description: This endpoint allows you to add new tags to a host, optionally
specifying where the tags came from.
- description: Specified host name to add new tags
in: path
name: host_name
required: true
schema:
type: string
- description: 'The source of the tags.

[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
Use "user" source for custom-defined tags.
example: chef
in: query
name: source
Expand All @@ -36934,15 +36947,15 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/HostTags'
$ref: '#/components/schemas/HostTagsInput'
description: Update host tags request body.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/HostTags'
$ref: '#/components/schemas/HostTagsOutput'
description: Created
'403':
content:
Expand All @@ -36969,16 +36982,14 @@ paths:
an integration source with those supplied in the request.'
operationId: UpdateHostTags
parameters:
- description: This endpoint allows you to update/replace all in an integration
source with those supplied in the request.
- description: Specified host name to change tags
in: path
name: host_name
required: true
schema:
type: string
- description: 'The source of the tags (for example chef, puppet).

[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)'
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
Use "user" source for custom-defined tags.
in: query
name: source
required: false
Expand All @@ -36988,15 +36999,15 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/HostTags'
$ref: '#/components/schemas/HostTagsInput'
description: Add tags to host
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/HostTags'
$ref: '#/components/schemas/HostTagsOutput'
description: OK
'403':
content:
Expand Down Expand Up @@ -40110,7 +40121,8 @@ tags:

by a source. For example, some valid sources include nagios, hudson, jenkins,

users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. [Complete
list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)


Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).'
Expand Down
8 changes: 4 additions & 4 deletions data/api/v1/translate_actions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1012,19 +1012,19 @@
"request_schema_description": "Details of the global variable to create."
},
"ListHostTags": {
"description": "Return a mapping of tags to hosts for your whole infrastructure.",
"summary": "Get Tags"
"description": "Returns a mapping of tags to hosts. For each tag, the response returns a list of host names that contain this tag. There is a restriction of 10k host names from the org that can be attached to tags and returned.",
"summary": "Get All Host Tags"
},
"DeleteHostTags": {
"description": "This endpoint allows you to remove all user-assigned tags\nfor a single host.",
"summary": "Remove host tags"
},
"GetHostTags": {
"description": "Return the list of tags that apply to a given host.",
"summary": "Get host tags"
"summary": "Get Host Tags"
},
"CreateHostTags": {
"description": "This endpoint allows you to add new tags to a host,\noptionally specifying where these tags come from.",
"description": "This endpoint allows you to add new tags to a host,\noptionally specifying what source these tags come from.",
"summary": "Add tags to a host",
"request_description": "Update host tags request body.",
"request_schema_description": "Set of tags to associate with your host."
Expand Down
2 changes: 1 addition & 1 deletion data/api/v1/translate_tags.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
},
"tags": {
"name": "Tags",
"description": "The tag endpoint allows you to assign tags to hosts,\nfor example: `role:database`. Those tags are applied to\nall metrics sent by the host. Refer to hosts by name\n(`yourhost.example.com`) when fetching and applying\ntags to a particular host.\n\nThe component of your infrastructure responsible for a tag is identified\nby a source. For example, some valid sources include nagios, hudson, jenkins,\nusers, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.\n\nRead more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/)."
"description": "The tag endpoint allows you to assign tags to hosts,\nfor example: `role:database`. Those tags are applied to\nall metrics sent by the host. Refer to hosts by name\n(`yourhost.example.com`) when fetching and applying\ntags to a particular host.\n\nThe component of your infrastructure responsible for a tag is identified\nby a source. For example, some valid sources include nagios, hudson, jenkins,\nusers, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)\n\nRead more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/)."
},
"timeboards": {
"name": "Timeboards",
Expand Down
Loading