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
+47-35Lines changed: 47 additions & 35 deletions
Original file line number
Diff line number
Diff line change
@@ -4261,7 +4261,7 @@ components:
4261
4261
example: false
4262
4262
type: boolean
4263
4263
type: object
4264
-
HostTags:
4264
+
HostTagsInput:
4265
4265
description: Set of tags to associate with your host.
4266
4266
properties:
4267
4267
host:
@@ -4276,6 +4276,21 @@ components:
4276
4276
type: string
4277
4277
type: array
4278
4278
type: object
4279
+
HostTagsOutput:
4280
+
description: Set of tags to associate with your host.
4281
+
properties:
4282
+
host:
4283
+
description: Your host name.
4284
+
example: test.host
4285
+
type: string
4286
+
tags:
4287
+
description: A list of tags attached to a given host.
4288
+
items:
4289
+
description: A given tag in a list.
4290
+
example: environment:production
4291
+
type: string
4292
+
type: array
4293
+
type: object
4279
4294
HostTotals:
4280
4295
description: Total number of host currently monitored by Datadog.
4281
4296
properties:
@@ -18900,18 +18915,18 @@ components:
18900
18915
- match
18901
18916
type: object
18902
18917
TagToHosts:
18903
-
description: In this object, the key is the tag, the value is a list of host
18904
-
names that are reporting that tag.
18918
+
description: In this object, the key is the tag, and the value is a list of
18919
+
host names that are reporting that tag.
18905
18920
properties:
18906
18921
tags:
18907
18922
additionalProperties:
18908
-
description: A list of additional properties for tags.
18923
+
description: A list of host names which contain this tag
18909
18924
items:
18910
18925
description: A given tag in a list.
18911
18926
example: test.metric.host
18912
18927
type: string
18913
18928
type: array
18914
-
description: A list of tags to apply to the host.
18929
+
description: A mapping of tags
18915
18930
type: object
18916
18931
type: object
18917
18932
TargetFormatType:
@@ -36781,11 +36796,13 @@ paths:
36781
36796
- synthetics_global_variable_write
36782
36797
/api/v1/tags/hosts:
36783
36798
get:
36784
-
description: Return a mapping of tags to hosts for your whole infrastructure.
36799
+
description: Returns a mapping of tags to hosts. For each tag, the response
36800
+
returns a list of host names that contain this tag. There is a restriction
36801
+
of 10k host names from the org that can be attached to tags and returned.
36785
36802
operationId: ListHostTags
36786
36803
parameters:
36787
-
- description: When specified, filters host list to those tags with the specified
36788
-
source.
36804
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36805
+
Use "user" source for custom-defined tags.
36789
36806
in: query
36790
36807
name: source
36791
36808
required: false
@@ -36816,7 +36833,7 @@ paths:
36816
36833
- apiKeyAuth: []
36817
36834
appKeyAuth: []
36818
36835
- AuthZ: []
36819
-
summary: Get Tags
36836
+
summary: Get All Host Tags
36820
36837
tags:
36821
36838
- Tags
36822
36839
x-menu-order: 1
@@ -36830,16 +36847,14 @@ paths:
36830
36847
for a single host.'
36831
36848
operationId: DeleteHostTags
36832
36849
parameters:
36833
-
- description: This endpoint allows you to remove all user-assigned tags for
36834
-
a single host.
36850
+
- description: Specified host name to delete tags
36835
36851
in: path
36836
36852
name: host_name
36837
36853
required: true
36838
36854
schema:
36839
36855
type: string
36840
-
- description: 'The source of the tags (for example chef, puppet).
36841
-
36842
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
36856
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36857
+
Use "user" source for custom-defined tags.
36843
36858
in: query
36844
36859
name: source
36845
36860
required: false
@@ -36870,14 +36885,14 @@ paths:
36870
36885
description: Return the list of tags that apply to a given host.
36871
36886
operationId: GetHostTags
36872
36887
parameters:
36873
-
- description: When specified, filters list of tags to those tags with the specified
36874
-
source.
36888
+
- description: Specified host name to view tags
36875
36889
in: path
36876
36890
name: host_name
36877
36891
required: true
36878
36892
schema:
36879
36893
type: string
36880
-
- description: Source to filter.
36894
+
- 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,
36913
36928
36914
-
optionally specifying where these tags come from.'
36929
+
optionally specifying what source these tags come from.'
36915
36930
operationId: CreateHostTags
36916
36931
parameters:
36917
-
- description: This endpoint allows you to add new tags to a host, optionally
36918
-
specifying where the tags came from.
36932
+
- description: Specified host name to add new tags
36919
36933
in: path
36920
36934
name: host_name
36921
36935
required: true
36922
36936
schema:
36923
36937
type: string
36924
-
- description: 'The source of the tags.
36925
-
36926
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
36938
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36939
+
Use "user" source for custom-defined tags.
36927
36940
example: chef
36928
36941
in: query
36929
36942
name: source
@@ -36934,15 +36947,15 @@ paths:
36934
36947
content:
36935
36948
application/json:
36936
36949
schema:
36937
-
$ref: '#/components/schemas/HostTags'
36950
+
$ref: '#/components/schemas/HostTagsInput'
36938
36951
description: Update host tags request body.
36939
36952
required: true
36940
36953
responses:
36941
36954
'201':
36942
36955
content:
36943
36956
application/json:
36944
36957
schema:
36945
-
$ref: '#/components/schemas/HostTags'
36958
+
$ref: '#/components/schemas/HostTagsOutput'
36946
36959
description: Created
36947
36960
'403':
36948
36961
content:
@@ -36969,16 +36982,14 @@ paths:
36969
36982
an integration source with those supplied in the request.'
36970
36983
operationId: UpdateHostTags
36971
36984
parameters:
36972
-
- description: This endpoint allows you to update/replace all in an integration
36973
-
source with those supplied in the request.
36985
+
- description: Specified host name to change tags
36974
36986
in: path
36975
36987
name: host_name
36976
36988
required: true
36977
36989
schema:
36978
36990
type: string
36979
-
- description: 'The source of the tags (for example chef, puppet).
36980
-
36981
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)'
36991
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36992
+
Use "user" source for custom-defined tags.
36982
36993
in: query
36983
36994
name: source
36984
36995
required: false
@@ -36988,15 +36999,15 @@ paths:
36988
36999
content:
36989
37000
application/json:
36990
37001
schema:
36991
-
$ref: '#/components/schemas/HostTags'
37002
+
$ref: '#/components/schemas/HostTagsInput'
36992
37003
description: Add tags to host
36993
37004
required: true
36994
37005
responses:
36995
37006
'201':
36996
37007
content:
36997
37008
application/json:
36998
37009
schema:
36999
-
$ref: '#/components/schemas/HostTags'
37010
+
$ref: '#/components/schemas/HostTagsOutput'
37000
37011
description: OK
37001
37012
'403':
37002
37013
content:
@@ -40110,7 +40121,8 @@ tags:
40110
40121
40111
40122
by a source. For example, some valid sources include nagios, hudson, jenkins,
40112
40123
40113
-
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
40124
+
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. [Complete
40125
+
list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)
40114
40126
40115
40127
40116
40128
Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).'
Copy file name to clipboardExpand all lines: data/api/v1/translate_actions.json
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1012,19 +1012,19 @@
1012
1012
"request_schema_description": "Details of the global variable to create."
1013
1013
},
1014
1014
"ListHostTags": {
1015
-
"description": "Return a mapping of tags to hosts for your whole infrastructure.",
1016
-
"summary": "Get Tags"
1015
+
"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.",
1016
+
"summary": "Get All Host Tags"
1017
1017
},
1018
1018
"DeleteHostTags": {
1019
1019
"description": "This endpoint allows you to remove all user-assigned tags\nfor a single host.",
1020
1020
"summary": "Remove host tags"
1021
1021
},
1022
1022
"GetHostTags": {
1023
1023
"description": "Return the list of tags that apply to a given host.",
1024
-
"summary": "Get host tags"
1024
+
"summary": "Get Host Tags"
1025
1025
},
1026
1026
"CreateHostTags": {
1027
-
"description": "This endpoint allows you to add new tags to a host,\noptionally specifying where these tags come from.",
1027
+
"description": "This endpoint allows you to add new tags to a host,\noptionally specifying what source these tags come from.",
Copy file name to clipboardExpand all lines: data/api/v1/translate_tags.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -121,7 +121,7 @@
121
121
},
122
122
"tags": {
123
123
"name": "Tags",
124
-
"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/)."
124
+
"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/)."
0 commit comments