You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: data/api/v1/full_spec.yaml
+35-33Lines changed: 35 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -4287,14 +4287,14 @@ components:
4287
4287
type: boolean
4288
4288
type: object
4289
4289
HostTags:
4290
-
description: Set of tags to associate with your host.
4290
+
description: Host name and an array of its tags
4291
4291
properties:
4292
4292
host:
4293
4293
description: Your host name.
4294
4294
example: test.host
4295
4295
type: string
4296
4296
tags:
4297
-
description: A list of tags to apply to the host.
4297
+
description: A list of tags associated with a host.
4298
4298
items:
4299
4299
description: A given tag in a list.
4300
4300
example: environment:production
@@ -18939,18 +18939,18 @@ components:
18939
18939
- match
18940
18940
type: object
18941
18941
TagToHosts:
18942
-
description: In this object, the key is the tag, the value is a list of host
18943
-
names that are reporting that tag.
18942
+
description: In this object, the key is the tag, and the value is a list of
18943
+
host names that are reporting that tag.
18944
18944
properties:
18945
18945
tags:
18946
18946
additionalProperties:
18947
-
description: A list of additional properties for tags.
18947
+
description: A list of host names which contain this tag
18948
18948
items:
18949
18949
description: A given tag in a list.
18950
18950
example: test.metric.host
18951
18951
type: string
18952
18952
type: array
18953
-
description: A list of tags to apply to the host.
18953
+
description: A mapping of tags to host names
18954
18954
type: object
18955
18955
type: object
18956
18956
TargetFormatType:
@@ -36880,11 +36880,13 @@ paths:
36880
36880
- synthetics_global_variable_write
36881
36881
/api/v1/tags/hosts:
36882
36882
get:
36883
-
description: Return a mapping of tags to hosts for your whole infrastructure.
36883
+
description: Returns a mapping of tags to hosts. For each tag, the response
36884
+
returns a list of host names that contain this tag. There is a restriction
36885
+
of 10k total host names from the org that can be attached to tags and returned.
36884
36886
operationId: ListHostTags
36885
36887
parameters:
36886
-
- description: When specified, filters host list to those tags with the specified
36887
-
source.
36888
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36889
+
Use "user" source for custom-defined tags.
36888
36890
in: query
36889
36891
name: source
36890
36892
required: false
@@ -36915,7 +36917,7 @@ paths:
36915
36917
- apiKeyAuth: []
36916
36918
appKeyAuth: []
36917
36919
- AuthZ: []
36918
-
summary: Get Tags
36920
+
summary: Get All Host Tags
36919
36921
tags:
36920
36922
- Tags
36921
36923
x-menu-order: 1
@@ -36924,21 +36926,21 @@ paths:
36924
36926
permissions: []
36925
36927
/api/v1/tags/hosts/{host_name}:
36926
36928
delete:
36927
-
description: 'This endpoint allows you to remove all user-assigned tags
36929
+
description: 'This endpoint allows you to remove all tags
36928
36930
36929
-
for a single host.'
36931
+
for a single host. If no source is specified, only deletes from the source
36932
+
"User".'
36930
36933
operationId: DeleteHostTags
36931
36934
parameters:
36932
-
- description: This endpoint allows you to remove all user-assigned tags for
36933
-
a single host.
36935
+
- description: Specified host name to delete tags
36934
36936
in: path
36935
36937
name: host_name
36936
36938
required: true
36937
36939
schema:
36938
36940
type: string
36939
-
- description: 'The source of the tags (for example chef, puppet).
36940
-
36941
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
36941
+
- description: Source of the tags to be deleted. [Complete list of source attribute
description: Return the list of tags that apply to a given host.
36970
36972
operationId: GetHostTags
36971
36973
parameters:
36972
-
- description: When specified, filters list of tags to those tags with the specified
36973
-
source.
36974
+
- description: Name of the host to retrieve tags for
36974
36975
in: path
36975
36976
name: host_name
36976
36977
required: true
36977
36978
schema:
36978
36979
type: string
36979
-
- description: Source to filter.
36980
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
description: 'This endpoint allows you to add new tags to a host,
37012
37014
37013
-
optionally specifying where these tags come from.'
37015
+
optionally specifying what source these tags come from. If tags already exist,
37016
+
appends new tags to the tag list. If no source is specified, defaults to "user".'
37014
37017
operationId: CreateHostTags
37015
37018
parameters:
37016
-
- description: This endpoint allows you to add new tags to a host, optionally
37017
-
specifying where the tags came from.
37019
+
- description: Specified host name to add new tags
37018
37020
in: path
37019
37021
name: host_name
37020
37022
required: true
37021
37023
schema:
37022
37024
type: string
37023
-
- description: 'The source of the tags.
37024
-
37025
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
37025
+
- description: Source to add tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
37026
+
Use "user" source for custom-defined tags. If no source is specified, defaults
37027
+
to "user".
37026
37028
example: chef
37027
37029
in: query
37028
37030
name: source
@@ -37068,16 +37070,15 @@ paths:
37068
37070
an integration source with those supplied in the request.'
37069
37071
operationId: UpdateHostTags
37070
37072
parameters:
37071
-
- description: This endpoint allows you to update/replace all in an integration
37072
-
source with those supplied in the request.
37073
+
- description: Specified host name to change tags
37073
37074
in: path
37074
37075
name: host_name
37075
37076
required: true
37076
37077
schema:
37077
37078
type: string
37078
-
- description: 'The source of the tags (for example chef, puppet).
37079
-
37080
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)'
37079
+
- description: Source to update tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
37080
+
Use "user" source for custom-defined tags. If no source specified, defaults
37081
+
to "user".
37081
37082
in: query
37082
37083
name: source
37083
37084
required: false
@@ -40212,7 +40213,8 @@ tags:
40212
40213
40213
40214
by a source. For example, some valid sources include nagios, hudson, jenkins,
40214
40215
40215
-
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
40216
+
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete
40217
+
list of source type names under [API Source Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
40216
40218
40217
40219
40218
40220
Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).'
0 commit comments