diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 7b0ed737c28..dae84070181 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -4206,7 +4206,7 @@ menu: - CreateHostTags unstable: [] order: 3 - - name: Get host tags + - name: Get Host Tags url: '#get-host-tags' identifier: tags-get-host-tags parent: tags @@ -4230,9 +4230,9 @@ menu: - DeleteHostTags unstable: [] order: 5 - - name: Get Tags - url: '#get-tags' - identifier: tags-get-tags + - name: Get All Host Tags + url: '#get-all-host-tags' + identifier: tags-get-all-host-tags parent: tags generated: true params: diff --git a/content/en/api/v1/tags/examples.json b/content/en/api/v1/tags/examples.json index fcb434323d1..d51b02824a9 100644 --- a/content/en/api/v1/tags/examples.json +++ b/content/en/api/v1/tags/examples.json @@ -9,7 +9,7 @@ ] } }, - "html": "
\n
\n
\n
\n

tags

\n
\n

object

\n

A list of tags to apply to the host.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n

A list of additional properties for tags.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

tags

\n
\n

object

\n

A mapping of tags to host names

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

[string]

\n

A list of host names which contain this tag

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -84,7 +84,7 @@ "environment:production" ] }, - "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags to apply to the host.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags associated with a host.

\n
\n \n
\n
" }, "403": { "json": { @@ -126,7 +126,7 @@ "environment:production" ] }, - "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags to apply to the host.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags associated with a host.

\n
\n \n
\n
" }, "403": { "json": { @@ -161,7 +161,7 @@ "environment:production" ] }, - "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags to apply to the host.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags associated with a host.

\n
\n \n
\n
" } }, "UpdateHostTags": { @@ -173,7 +173,7 @@ "environment:production" ] }, - "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags to apply to the host.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags associated with a host.

\n
\n \n
\n
" }, "403": { "json": { @@ -208,7 +208,7 @@ "environment:production" ] }, - "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags to apply to the host.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

host

\n
\n

string

\n

Your host name.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags associated with a host.

\n
\n \n
\n
" } } } \ No newline at end of file diff --git a/data/api/v1/full_spec.yaml b/data/api/v1/full_spec.yaml index 596f93f559b..2448c409d17 100644 --- a/data/api/v1/full_spec.yaml +++ b/data/api/v1/full_spec.yaml @@ -4287,14 +4287,14 @@ components: type: boolean type: object HostTags: - description: Set of tags to associate with your host. + description: Host name and an array of its tags properties: host: description: Your host name. example: test.host type: string tags: - description: A list of tags to apply to the host. + description: A list of tags associated with a host. items: description: A given tag in a list. example: environment:production @@ -18939,18 +18939,18 @@ components: - match type: object TagToHosts: - description: In this object, the key is the tag, the value is a list of host - names that are reporting that tag. + description: In this object, the key is the tag, and the value is a list of + host names that are reporting that tag. properties: tags: additionalProperties: - description: A list of additional properties for tags. + description: A list of host names which contain this tag items: description: A given tag in a list. example: test.metric.host type: string type: array - description: A list of tags to apply to the host. + description: A mapping of tags to host names type: object type: object TargetFormatType: @@ -36880,11 +36880,13 @@ paths: - synthetics_global_variable_write /api/v1/tags/hosts: get: - description: Return a mapping of tags to hosts for your whole infrastructure. + 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. operationId: ListHostTags parameters: - - description: When specified, filters host list to those tags with the specified - source. + - description: 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. in: query name: source required: false @@ -36915,7 +36917,7 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] - summary: Get Tags + summary: Get All Host Tags tags: - Tags x-menu-order: 1 @@ -36924,21 +36926,21 @@ paths: permissions: [] /api/v1/tags/hosts/{host_name}: delete: - description: 'This endpoint allows you to remove all user-assigned tags + description: 'This endpoint allows you to remove all tags - for a single host.' + for a single host. If no source is specified, only deletes from the source + "User".' operationId: DeleteHostTags parameters: - - description: This endpoint allows you to remove all user-assigned tags for - a single host. + - description: Specified host name to delete tags in: path name: host_name required: true schema: type: string - - description: 'The source of the tags (for example chef, puppet). - - [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' + - description: 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. in: query name: source required: false @@ -36969,14 +36971,14 @@ paths: description: Return the list of tags that apply to a given host. operationId: GetHostTags parameters: - - description: When specified, filters list of tags to those tags with the specified - source. + - description: Name of the host to retrieve tags for in: path name: host_name required: true schema: type: string - - description: Source to filter. + - description: 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. in: query name: source required: false @@ -37003,26 +37005,26 @@ paths: description: Not Found '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get host tags + summary: Get Host Tags tags: - Tags x-menu-order: 2 post: description: 'This endpoint allows you to add new tags to a host, - optionally specifying where these tags come from.' + optionally specifying what source these tags come from. If tags exist, appends + tags to the end of the existing tag list' operationId: CreateHostTags parameters: - - description: This endpoint allows you to add new tags to a host, optionally - specifying where the tags came from. + - description: Specified host name to add new tags in: path name: host_name required: true schema: type: string - - description: 'The source of the tags. - - [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).' + - description: 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". example: chef in: query name: source @@ -37068,16 +37070,15 @@ paths: an integration source with those supplied in the request.' operationId: UpdateHostTags parameters: - - description: This endpoint allows you to update/replace all in an integration - source with those supplied in the request. + - description: Specified host name to change tags in: path name: host_name required: true schema: type: string - - description: 'The source of the tags (for example chef, puppet). - - [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value)' + - description: 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". in: query name: source required: false @@ -40212,7 +40213,8 @@ tags: by a source. For example, some valid sources include nagios, hudson, jenkins, - users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc. + 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). Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).' diff --git a/data/api/v1/translate_actions.json b/data/api/v1/translate_actions.json index 0c85f030d10..a9d18aa3024 100644 --- a/data/api/v1/translate_actions.json +++ b/data/api/v1/translate_actions.json @@ -1012,28 +1012,28 @@ "request_schema_description": "Details of the global variable to create." }, "ListHostTags": { - "description": "Return a mapping of tags to hosts for your whole infrastructure.", - "summary": "Get Tags" + "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.", + "summary": "Get All Host Tags" }, "DeleteHostTags": { - "description": "This endpoint allows you to remove all user-assigned tags\nfor a single host.", + "description": "This endpoint allows you to remove all tags\nfor a single host. If no source is specified, only deletes from the source \"User\".", "summary": "Remove host tags" }, "GetHostTags": { "description": "Return the list of tags that apply to a given host.", - "summary": "Get host tags" + "summary": "Get Host Tags" }, "CreateHostTags": { - "description": "This endpoint allows you to add new tags to a host,\noptionally specifying where these tags come from.", + "description": "This endpoint allows you to add new tags to a host,\noptionally specifying what source these tags come from. If tags exist, appends tags to the end of the existing tag list", "summary": "Add tags to a host", "request_description": "Update host tags request body.", - "request_schema_description": "Set of tags to associate with your host." + "request_schema_description": "Host name and an array of its tags" }, "UpdateHostTags": { "description": "This endpoint allows you to update/replace all tags in\nan integration source with those supplied in the request.", "summary": "Update host tags", "request_description": "Add tags to host", - "request_schema_description": "Set of tags to associate with your host." + "request_schema_description": "Host name and an array of its tags" }, "GetUsageAnalyzedLogs": { "description": "Get hourly usage for analyzed logs (Security Monitoring).\n**Note:** This endpoint has been deprecated. Hourly usage data for all products is now available in the [Get hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family). Refer to [Migrating from the V1 Hourly Usage APIs to V2](https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/) for the associated migration guide.", diff --git a/data/api/v1/translate_tags.json b/data/api/v1/translate_tags.json index 40cb0e7664c..8febeef9c92 100644 --- a/data/api/v1/translate_tags.json +++ b/data/api/v1/translate_tags.json @@ -121,7 +121,7 @@ }, "tags": { "name": "Tags", - "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/)." + "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. Find a complete list of source type names under [API Source Attributes](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/)." }, "timeboards": { "name": "Timeboards",