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
+50-37Lines changed: 50 additions & 37 deletions
Original file line number
Diff line number
Diff line change
@@ -4286,7 +4286,7 @@ components:
4286
4286
example: false
4287
4287
type: boolean
4288
4288
type: object
4289
-
HostTags:
4289
+
HostTagsInput:
4290
4290
description: Set of tags to associate with your host.
4291
4291
properties:
4292
4292
host:
@@ -4301,6 +4301,21 @@ components:
4301
4301
type: string
4302
4302
type: array
4303
4303
type: object
4304
+
HostTagsOutput:
4305
+
description: Host name and an array of its tags
4306
+
properties:
4307
+
host:
4308
+
description: Your host name.
4309
+
example: test.host
4310
+
type: string
4311
+
tags:
4312
+
description: A list of tags attached to a given host.
4313
+
items:
4314
+
description: A given tag in a list.
4315
+
example: environment:production
4316
+
type: string
4317
+
type: array
4318
+
type: object
4304
4319
HostTotals:
4305
4320
description: Total number of host currently monitored by Datadog.
4306
4321
properties:
@@ -18925,18 +18940,18 @@ components:
18925
18940
- match
18926
18941
type: object
18927
18942
TagToHosts:
18928
-
description: In this object, the key is the tag, the value is a list of host
18929
-
names that are reporting that tag.
18943
+
description: In this object, the key is the tag, and the value is a list of
18944
+
host names that are reporting that tag.
18930
18945
properties:
18931
18946
tags:
18932
18947
additionalProperties:
18933
-
description: A list of additional properties for tags.
18948
+
description: A list of host names which contain this tag
18934
18949
items:
18935
18950
description: A given tag in a list.
18936
18951
example: test.metric.host
18937
18952
type: string
18938
18953
type: array
18939
-
description: A list of tags to apply to the host.
18954
+
description: A mapping of tags to host names
18940
18955
type: object
18941
18956
type: object
18942
18957
TargetFormatType:
@@ -36866,11 +36881,13 @@ paths:
36866
36881
- synthetics_global_variable_write
36867
36882
/api/v1/tags/hosts:
36868
36883
get:
36869
-
description: Return a mapping of tags to hosts for your whole infrastructure.
36884
+
description: Returns a mapping of tags to hosts. For each tag, the response
36885
+
returns a list of host names that contain this tag. There is a restriction
36886
+
of 10k total host names from the org that can be attached to tags and returned.
36870
36887
operationId: ListHostTags
36871
36888
parameters:
36872
-
- description: When specified, filters host list to those tags with the specified
36873
-
source.
36889
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36890
+
Use "user" source for custom-defined tags.
36874
36891
in: query
36875
36892
name: source
36876
36893
required: false
@@ -36901,7 +36918,7 @@ paths:
36901
36918
- apiKeyAuth: []
36902
36919
appKeyAuth: []
36903
36920
- AuthZ: []
36904
-
summary: Get Tags
36921
+
summary: Get All Host Tags
36905
36922
tags:
36906
36923
- Tags
36907
36924
x-menu-order: 1
@@ -36910,21 +36927,20 @@ paths:
36910
36927
permissions: []
36911
36928
/api/v1/tags/hosts/{host_name}:
36912
36929
delete:
36913
-
description: 'This endpoint allows you to remove all user-assigned tags
36930
+
description: 'This endpoint allows you to remove all tags
36914
36931
36915
-
for a single host.'
36932
+
for a single host. If no source is specified, only deletes tags with no source.'
36916
36933
operationId: DeleteHostTags
36917
36934
parameters:
36918
-
- description: This endpoint allows you to remove all user-assigned tags for
36919
-
a single host.
36935
+
- description: Specified host name to delete tags
36920
36936
in: path
36921
36937
name: host_name
36922
36938
required: true
36923
36939
schema:
36924
36940
type: string
36925
-
- description: 'The source of the tags (for example chef, puppet).
36926
-
36927
-
[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.
36956
36972
operationId: GetHostTags
36957
36973
parameters:
36958
-
- description: When specified, filters list of tags to those tags with the specified
36959
-
source.
36974
+
- description: Name of the host to retrieve tags for
36960
36975
in: path
36961
36976
name: host_name
36962
36977
required: true
36963
36978
schema:
36964
36979
type: string
36965
-
- 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,
36998
37014
36999
-
optionally specifying where these tags come from.'
37015
+
optionally specifying what source these tags come from.'
37000
37016
operationId: CreateHostTags
37001
37017
parameters:
37002
-
- description: This endpoint allows you to add new tags to a host, optionally
37003
-
specifying where the tags came from.
37018
+
- description: Specified host name to add new tags
37004
37019
in: path
37005
37020
name: host_name
37006
37021
required: true
37007
37022
schema:
37008
37023
type: string
37009
-
- description: 'The source of the tags.
37010
-
37011
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
37024
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
37025
+
Use "user" source for custom-defined tags.
37012
37026
example: chef
37013
37027
in: query
37014
37028
name: source
@@ -37019,15 +37033,15 @@ paths:
37019
37033
content:
37020
37034
application/json:
37021
37035
schema:
37022
-
$ref: '#/components/schemas/HostTags'
37036
+
$ref: '#/components/schemas/HostTagsInput'
37023
37037
description: Update host tags request body.
37024
37038
required: true
37025
37039
responses:
37026
37040
'201':
37027
37041
content:
37028
37042
application/json:
37029
37043
schema:
37030
-
$ref: '#/components/schemas/HostTags'
37044
+
$ref: '#/components/schemas/HostTagsOutput'
37031
37045
description: Created
37032
37046
'403':
37033
37047
content:
@@ -37054,16 +37068,14 @@ paths:
37054
37068
an integration source with those supplied in the request.'
37055
37069
operationId: UpdateHostTags
37056
37070
parameters:
37057
-
- description: This endpoint allows you to update/replace all in an integration
37058
-
source with those supplied in the request.
37071
+
- description: Specified host name to change tags
37059
37072
in: path
37060
37073
name: host_name
37061
37074
required: true
37062
37075
schema:
37063
37076
type: string
37064
-
- description: 'The source of the tags (for example chef, puppet).
37065
-
37066
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)'
37077
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
37078
+
Use "user" source for custom-defined tags.
37067
37079
in: query
37068
37080
name: source
37069
37081
required: false
@@ -37073,15 +37085,15 @@ paths:
37073
37085
content:
37074
37086
application/json:
37075
37087
schema:
37076
-
$ref: '#/components/schemas/HostTags'
37088
+
$ref: '#/components/schemas/HostTagsInput'
37077
37089
description: Add tags to host
37078
37090
required: true
37079
37091
responses:
37080
37092
'201':
37081
37093
content:
37082
37094
application/json:
37083
37095
schema:
37084
-
$ref: '#/components/schemas/HostTags'
37096
+
$ref: '#/components/schemas/HostTagsOutput'
37085
37097
description: OK
37086
37098
'403':
37087
37099
content:
@@ -40195,7 +40207,8 @@ tags:
40195
40207
40196
40208
by a source. For example, some valid sources include nagios, hudson, jenkins,
40197
40209
40198
-
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
40210
+
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete
40211
+
list of source type names under [API Source Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
40199
40212
40200
40213
40201
40214
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
+5-5Lines changed: 5 additions & 5 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 total 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
-
"description": "This endpoint allows you to remove all user-assigned tags\nfor a single host.",
1019
+
"description": "This endpoint allows you to remove all tags\nfor a single host. If no source is specified, only deletes tags with no source.",
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.",
0 commit comments