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: .generator/schemas/v1/openapi.yaml
+35-33Lines changed: 35 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -4180,14 +4180,14 @@ components:
4180
4180
type: boolean
4181
4181
type: object
4182
4182
HostTags:
4183
-
description: Set of tags to associate with your host.
4183
+
description: Host name and an array of its tags
4184
4184
properties:
4185
4185
host:
4186
4186
description: Your host name.
4187
4187
example: test.host
4188
4188
type: string
4189
4189
tags:
4190
-
description: A list of tags to apply to the host.
4190
+
description: A list of tags associated with a host.
4191
4191
items:
4192
4192
description: A given tag in a list.
4193
4193
example: environment:production
@@ -18703,18 +18703,18 @@ components:
18703
18703
- match
18704
18704
type: object
18705
18705
TagToHosts:
18706
-
description: In this object, the key is the tag, the value is a list of host
18707
-
names that are reporting that tag.
18706
+
description: In this object, the key is the tag, and the value is a list of
18707
+
host names that are reporting that tag.
18708
18708
properties:
18709
18709
tags:
18710
18710
additionalProperties:
18711
-
description: A list of additional properties for tags.
18711
+
description: A list of host names which contain this tag
18712
18712
items:
18713
18713
description: A given tag in a list.
18714
18714
example: test.metric.host
18715
18715
type: string
18716
18716
type: array
18717
-
description: A list of tags to apply to the host.
18717
+
description: A mapping of tags to host names
18718
18718
type: object
18719
18719
type: object
18720
18720
TargetFormatType:
@@ -35726,11 +35726,13 @@ paths:
35726
35726
- synthetics_global_variable_write
35727
35727
/api/v1/tags/hosts:
35728
35728
get:
35729
-
description: Return a mapping of tags to hosts for your whole infrastructure.
35729
+
description: Returns a mapping of tags to hosts. For each tag, the response
35730
+
returns a list of host names that contain this tag. There is a restriction
35731
+
of 10k total host names from the org that can be attached to tags and returned.
35730
35732
operationId: ListHostTags
35731
35733
parameters:
35732
-
- description: When specified, filters host list to those tags with the specified
35733
-
source.
35734
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
35735
+
Use "user" source for custom-defined tags.
35734
35736
in: query
35735
35737
name: source
35736
35738
required: false
@@ -35761,29 +35763,29 @@ paths:
35761
35763
- apiKeyAuth: []
35762
35764
appKeyAuth: []
35763
35765
- AuthZ: []
35764
-
summary: Get Tags
35766
+
summary: Get All Host Tags
35765
35767
tags:
35766
35768
- Tags
35767
35769
x-permission:
35768
35770
operator: OPEN
35769
35771
permissions: []
35770
35772
/api/v1/tags/hosts/{host_name}:
35771
35773
delete:
35772
-
description: 'This endpoint allows you to remove all user-assigned tags
35774
+
description: 'This endpoint allows you to remove all tags
35773
35775
35774
-
for a single host.'
35776
+
for a single host. If no source is specified, only deletes from the source
35777
+
"User".'
35775
35778
operationId: DeleteHostTags
35776
35779
parameters:
35777
-
- description: This endpoint allows you to remove all user-assigned tags for
35778
-
a single host.
35780
+
- description: Specified host name to delete tags
35779
35781
in: path
35780
35782
name: host_name
35781
35783
required: true
35782
35784
schema:
35783
35785
type: string
35784
-
- description: 'The source of the tags (for example chef, puppet).
35785
-
35786
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
35786
+
- 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.
35814
35816
operationId: GetHostTags
35815
35817
parameters:
35816
-
- description: When specified, filters list of tags to those tags with the specified
35817
-
source.
35818
+
- description: Name of the host to retrieve tags for
35818
35819
in: path
35819
35820
name: host_name
35820
35821
required: true
35821
35822
schema:
35822
35823
type: string
35823
-
- description: Source to filter.
35824
+
- 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,
35855
35857
35856
-
optionally specifying where these tags come from.'
35858
+
optionally specifying what source these tags come from. If tags already exist,
35859
+
appends new tags to the tag list. If no source is specified, defaults to "user".'
35857
35860
operationId: CreateHostTags
35858
35861
parameters:
35859
-
- description: This endpoint allows you to add new tags to a host, optionally
35860
-
specifying where the tags came from.
35862
+
- description: Specified host name to add new tags
35861
35863
in: path
35862
35864
name: host_name
35863
35865
required: true
35864
35866
schema:
35865
35867
type: string
35866
-
- description: 'The source of the tags.
35867
-
35868
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
35868
+
- description: Source to add tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
35869
+
Use "user" source for custom-defined tags. If no source is specified, defaults
35870
+
to "user".
35869
35871
example: chef
35870
35872
in: query
35871
35873
name: source
@@ -35910,16 +35912,15 @@ paths:
35910
35912
an integration source with those supplied in the request.'
35911
35913
operationId: UpdateHostTags
35912
35914
parameters:
35913
-
- description: This endpoint allows you to update/replace all in an integration
35914
-
source with those supplied in the request.
35915
+
- description: Specified host name to change tags
35915
35916
in: path
35916
35917
name: host_name
35917
35918
required: true
35918
35919
schema:
35919
35920
type: string
35920
-
- description: 'The source of the tags (for example chef, puppet).
35921
-
35922
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)'
35921
+
- description: Source to update tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
35922
+
Use "user" source for custom-defined tags. If no source specified, defaults
35923
+
to "user".
35923
35924
in: query
35924
35925
name: source
35925
35926
required: false
@@ -38935,7 +38936,8 @@ tags:
38935
38936
38936
38937
by a source. For example, some valid sources include nagios, hudson, jenkins,
38937
38938
38938
-
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
38939
+
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete
38940
+
list of source type names under [API Source Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
38939
38941
38940
38942
38941
38943
Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).'
Copy file name to clipboardExpand all lines: src/datadog_api_client/v1/api/tags_api.py
+16-19Lines changed: 16 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ class TagsApi:
25
25
26
26
The component of your infrastructure responsible for a tag is identified
27
27
by a source. For example, some valid sources include nagios, hudson, jenkins,
28
-
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
28
+
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete list of source type names under `API Source Attributes <https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value>`_.
29
29
30
30
Read more about tags on `Getting Started with Tags <https://docs.datadoghq.com/getting_started/tagging/>`_.
31
31
"""
@@ -185,14 +185,13 @@ def create_host_tags(
185
185
"""Add tags to a host.
186
186
187
187
This endpoint allows you to add new tags to a host,
188
-
optionally specifying where these tags come from.
188
+
optionally specifying what source these tags come from. If tags already exist, appends new tags to the tag list. If no source is specified, defaults to "user".
189
189
190
-
:param host_name: This endpoint allows you to add new tags to a host, optionally specifying where the tags came from.
190
+
:param host_name: Specified host name to add new tags
191
191
:type host_name: str
192
192
:param body: Update host tags request body.
193
193
:type body: HostTags
194
-
:param source: The source of the tags.
195
-
`Complete list of source attribute values <https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value>`_.
194
+
:param source: Source to add tags. `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. If no source is specified, defaults to "user".
196
195
:type source: str, optional
197
196
:rtype: HostTags
198
197
"""
@@ -214,13 +213,12 @@ def delete_host_tags(
214
213
) ->None:
215
214
"""Remove host tags.
216
215
217
-
This endpoint allows you to remove all user-assigned tags
218
-
for a single host.
216
+
This endpoint allows you to remove all tags
217
+
for a single host. If no source is specified, only deletes from the source "User".
219
218
220
-
:param host_name: This endpoint allows you to remove all user-assigned tags for a single host.
219
+
:param host_name: Specified host name to delete tags
221
220
:type host_name: str
222
-
:param source: The source of the tags (for example chef, puppet).
223
-
`Complete list of source attribute values <https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value>`_.
221
+
:param source: Source of the tags to be deleted. `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.
224
222
:type source: str, optional
225
223
:rtype: None
226
224
"""
@@ -238,13 +236,13 @@ def get_host_tags(
238
236
*,
239
237
source: Union[str, UnsetType] =unset,
240
238
) ->HostTags:
241
-
"""Get host tags.
239
+
"""Get Host Tags.
242
240
243
241
Return the list of tags that apply to a given host.
244
242
245
-
:param host_name: When specified, filters list of tags to those tags with the specified source.
243
+
:param host_name: Name of the host to retrieve tags for
246
244
:type host_name: str
247
-
:param source: Source to filter.
245
+
:param source: 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.
248
246
:type source: str, optional
249
247
:rtype: HostTags
250
248
"""
@@ -261,11 +259,11 @@ def list_host_tags(
261
259
*,
262
260
source: Union[str, UnsetType] =unset,
263
261
) ->TagToHosts:
264
-
"""Get Tags.
262
+
"""Get All Host Tags.
265
263
266
-
Return a mapping of tags to hosts for your whole infrastructure.
264
+
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.
267
265
268
-
:param source: When specified, filters host list to those tags with the specified source.
266
+
:param source: 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.
269
267
:type source: str, optional
270
268
:rtype: TagToHosts
271
269
"""
@@ -287,12 +285,11 @@ def update_host_tags(
287
285
This endpoint allows you to update/replace all tags in
288
286
an integration source with those supplied in the request.
289
287
290
-
:param host_name: This endpoint allows you to update/replace all in an integration source with those supplied in the request.
288
+
:param host_name: Specified host name to change tags
291
289
:type host_name: str
292
290
:param body: Add tags to host
293
291
:type body: HostTags
294
-
:param source: The source of the tags (for example chef, puppet).
295
-
`Complete list of source attribute values <https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value>`_
292
+
:param source: Source to update tags. `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. If no source specified, defaults to "user".
0 commit comments