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
@@ -4219,14 +4219,14 @@ components:
4219
4219
type: boolean
4220
4220
type: object
4221
4221
HostTags:
4222
-
description: Set of tags to associate with your host.
4222
+
description: Host name and an array of its tags
4223
4223
properties:
4224
4224
host:
4225
4225
description: Your host name.
4226
4226
example: test.host
4227
4227
type: string
4228
4228
tags:
4229
-
description: A list of tags to apply to the host.
4229
+
description: A list of tags associated with a host.
4230
4230
items:
4231
4231
description: A given tag in a list.
4232
4232
example: environment:production
@@ -18972,18 +18972,18 @@ components:
18972
18972
- match
18973
18973
type: object
18974
18974
TagToHosts:
18975
-
description: In this object, the key is the tag, the value is a list of host
18976
-
names that are reporting that tag.
18975
+
description: In this object, the key is the tag, and the value is a list of
18976
+
host names that are reporting that tag.
18977
18977
properties:
18978
18978
tags:
18979
18979
additionalProperties:
18980
-
description: A list of additional properties for tags.
18980
+
description: A list of host names which contain this tag
18981
18981
items:
18982
18982
description: A given tag in a list.
18983
18983
example: test.metric.host
18984
18984
type: string
18985
18985
type: array
18986
-
description: A list of tags to apply to the host.
18986
+
description: A mapping of tags to host names
18987
18987
type: object
18988
18988
type: object
18989
18989
TargetFormatType:
@@ -36008,11 +36008,13 @@ paths:
36008
36008
- synthetics_global_variable_write
36009
36009
/api/v1/tags/hosts:
36010
36010
get:
36011
-
description: Return a mapping of tags to hosts for your whole infrastructure.
36011
+
description: Returns a mapping of tags to hosts. For each tag, the response
36012
+
returns a list of host names that contain this tag. There is a restriction
36013
+
of 10k total host names from the org that can be attached to tags and returned.
36012
36014
operationId: ListHostTags
36013
36015
parameters:
36014
-
- description: When specified, filters host list to those tags with the specified
36015
-
source.
36016
+
- description: Source to filter. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36017
+
Use "user" source for custom-defined tags.
36016
36018
in: query
36017
36019
name: source
36018
36020
required: false
@@ -36043,29 +36045,29 @@ paths:
36043
36045
- apiKeyAuth: []
36044
36046
appKeyAuth: []
36045
36047
- AuthZ: []
36046
-
summary: Get Tags
36048
+
summary: Get All Host Tags
36047
36049
tags:
36048
36050
- Tags
36049
36051
x-permission:
36050
36052
operator: OPEN
36051
36053
permissions: []
36052
36054
/api/v1/tags/hosts/{host_name}:
36053
36055
delete:
36054
-
description: 'This endpoint allows you to remove all user-assigned tags
36056
+
description: 'This endpoint allows you to remove all tags
36055
36057
36056
-
for a single host.'
36058
+
for a single host. If no source is specified, only deletes from the source
36059
+
"User".'
36057
36060
operationId: DeleteHostTags
36058
36061
parameters:
36059
-
- description: This endpoint allows you to remove all user-assigned tags for
36060
-
a single host.
36062
+
- description: Specified host name to delete tags
36061
36063
in: path
36062
36064
name: host_name
36063
36065
required: true
36064
36066
schema:
36065
36067
type: string
36066
-
- description: 'The source of the tags (for example chef, puppet).
36067
-
36068
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
36068
+
- 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.
36096
36098
operationId: GetHostTags
36097
36099
parameters:
36098
-
- description: When specified, filters list of tags to those tags with the specified
36099
-
source.
36100
+
- description: Name of the host to retrieve tags for
36100
36101
in: path
36101
36102
name: host_name
36102
36103
required: true
36103
36104
schema:
36104
36105
type: string
36105
-
- description: Source to filter.
36106
+
- 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,
36137
36139
36138
-
optionally specifying where these tags come from.'
36140
+
optionally specifying what source these tags come from. If tags already exist,
36141
+
appends new tags to the tag list. If no source is specified, defaults to "user".'
36139
36142
operationId: CreateHostTags
36140
36143
parameters:
36141
-
- description: This endpoint allows you to add new tags to a host, optionally
36142
-
specifying where the tags came from.
36144
+
- description: Specified host name to add new tags
36143
36145
in: path
36144
36146
name: host_name
36145
36147
required: true
36146
36148
schema:
36147
36149
type: string
36148
-
- description: 'The source of the tags.
36149
-
36150
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
36150
+
- description: Source to add tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36151
+
Use "user" source for custom-defined tags. If no source is specified, defaults
36152
+
to "user".
36151
36153
example: chef
36152
36154
in: query
36153
36155
name: source
@@ -36192,16 +36194,15 @@ paths:
36192
36194
an integration source with those supplied in the request.'
36193
36195
operationId: UpdateHostTags
36194
36196
parameters:
36195
-
- description: This endpoint allows you to update/replace all in an integration
36196
-
source with those supplied in the request.
36197
+
- description: Specified host name to change tags
36197
36198
in: path
36198
36199
name: host_name
36199
36200
required: true
36200
36201
schema:
36201
36202
type: string
36202
-
- description: 'The source of the tags (for example chef, puppet).
36203
-
36204
-
[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)'
36203
+
- description: Source to update tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
36204
+
Use "user" source for custom-defined tags. If no source specified, defaults
36205
+
to "user".
36205
36206
in: query
36206
36207
name: source
36207
36208
required: false
@@ -39217,7 +39218,8 @@ tags:
39217
39218
39218
39219
by a source. For example, some valid sources include nagios, hudson, jenkins,
39219
39220
39220
-
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
39221
+
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. Find a complete
39222
+
list of source type names under [API Source Attributes](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
39221
39223
39222
39224
39223
39225
Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).'
Copy file name to clipboardExpand all lines: services/tags/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ tags to a particular host.
10
10
11
11
The component of your infrastructure responsible for a tag is identified
12
12
by a source. For example, some valid sources include nagios, hudson, jenkins,
13
-
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
13
+
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).
14
14
15
15
Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).
* [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
625
+
* 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".
627
626
* @type string
628
627
*/
629
628
source?: string;
630
629
}
631
630
632
631
exportinterfaceTagsApiDeleteHostTagsRequest{
633
632
/**
634
-
* This endpoint allows you to remove all user-assigned tags for a single host.
633
+
* Specified host name to delete tags
635
634
* @type string
636
635
*/
637
636
hostName: string;
638
637
/**
639
-
* The source of the tags (for example chef, puppet).
640
-
* [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).
638
+
* 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.
641
639
* @type string
642
640
*/
643
641
source?: string;
644
642
}
645
643
646
644
exportinterfaceTagsApiGetHostTagsRequest{
647
645
/**
648
-
* When specified, filters list of tags to those tags with the specified source.
646
+
* Name of the host to retrieve tags for
649
647
* @type string
650
648
*/
651
649
hostName: string;
652
650
/**
653
-
* Source to filter.
651
+
* 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.
654
652
* @type string
655
653
*/
656
654
source?: string;
657
655
}
658
656
659
657
exportinterfaceTagsApiListHostTagsRequest{
660
658
/**
661
-
* When specified, filters host list to those tags with the specified source.
659
+
* 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.
662
660
* @type string
663
661
*/
664
662
source?: string;
665
663
}
666
664
667
665
exportinterfaceTagsApiUpdateHostTagsRequest{
668
666
/**
669
-
* This endpoint allows you to update/replace all in an integration source with those supplied in the request.
* The source of the tags (for example chef, puppet).
680
-
* [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)
677
+
* 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".
681
678
* @type string
682
679
*/
683
680
source?: string;
@@ -704,7 +701,7 @@ export class TagsApi {
704
701
705
702
/**
706
703
* This endpoint allows you to add new tags to a host,
707
-
* optionally specifying where these tags come from.
704
+
* 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".
708
705
* @param param The request object
709
706
*/
710
707
publiccreateHostTags(
@@ -727,8 +724,8 @@ export class TagsApi {
727
724
}
728
725
729
726
/**
730
-
* This endpoint allows you to remove all user-assigned tags
731
-
* for a single host.
727
+
* This endpoint allows you to remove all tags
728
+
* for a single host. If no source is specified, only deletes from the source "User".
732
729
* @param param The request object
733
730
*/
734
731
publicdeleteHostTags(
@@ -772,7 +769,7 @@ export class TagsApi {
772
769
}
773
770
774
771
/**
775
-
* Return a mapping of tags to hosts for your whole infrastructure.
772
+
* 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.
0 commit comments