Skip to content

Add Status Pages API specs #3378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Status Pages API specs #3378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 33 additions & 35 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4219,14 +4219,14 @@ components:
type: boolean
type: object
HostTags:
description: Host name and an array of its tags
description: Set of tags to associate with your host.
properties:
host:
description: Your host name.
example: test.host
type: string
tags:
description: A list of tags associated with a host.
description: A list of tags to apply to the host.
items:
description: A given tag in a list.
example: environment:production
Expand Down Expand Up @@ -18972,18 +18972,18 @@ components:
- match
type: object
TagToHosts:
description: In this object, the key is the tag, and the value is a list of
host names that are reporting that tag.
description: In this object, the key is the tag, the value is a list of host
names that are reporting that tag.
properties:
tags:
additionalProperties:
description: A list of host names which contain this tag
description: A list of additional properties for tags.
items:
description: A given tag in a list.
example: test.metric.host
type: string
type: array
description: A mapping of tags to host names
description: A list of tags to apply to the host.
type: object
type: object
TargetFormatType:
Expand Down Expand Up @@ -36008,13 +36008,11 @@ paths:
- synthetics_global_variable_write
/api/v1/tags/hosts:
get:
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.
description: Return a mapping of tags to hosts for your whole infrastructure.
operationId: ListHostTags
parameters:
- 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.
- description: When specified, filters host list to those tags with the specified
source.
in: query
name: source
required: false
Expand Down Expand Up @@ -36045,29 +36043,29 @@ paths:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
summary: Get All Host Tags
summary: Get Tags
tags:
- Tags
x-permission:
operator: OPEN
permissions: []
/api/v1/tags/hosts/{host_name}:
delete:
description: 'This endpoint allows you to remove all tags
description: 'This endpoint allows you to remove all user-assigned tags

for a single host. If no source is specified, only deletes from the source
"User".'
for a single host.'
operationId: DeleteHostTags
parameters:
- description: Specified host name to delete tags
- description: This endpoint allows you to remove all user-assigned tags for
a single host.
in: path
name: host_name
required: true
schema:
type: string
- 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.
- 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).'
in: query
name: source
required: false
Expand Down Expand Up @@ -36097,14 +36095,14 @@ paths:
description: Return the list of tags that apply to a given host.
operationId: GetHostTags
parameters:
- description: Name of the host to retrieve tags for
- description: When specified, filters list of tags to those tags with the specified
source.
in: path
name: host_name
required: true
schema:
type: string
- 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.
- description: Source to filter.
in: query
name: source
required: false
Expand All @@ -36131,25 +36129,25 @@ paths:
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get Host Tags
summary: Get host tags
tags:
- Tags
post:
description: 'This endpoint allows you to add new tags to a host,

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".'
optionally specifying where these tags come from.'
operationId: CreateHostTags
parameters:
- description: Specified host name to add new tags
- description: This endpoint allows you to add new tags to a host, optionally
specifying where the tags came from.
in: path
name: host_name
required: true
schema:
type: string
- 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".
- description: 'The source of the tags.

[Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value).'
example: chef
in: query
name: source
Expand Down Expand Up @@ -36194,15 +36192,16 @@ paths:
an integration source with those supplied in the request.'
operationId: UpdateHostTags
parameters:
- description: Specified host name to change tags
- description: This endpoint allows you to update/replace all in an integration
source with those supplied in the request.
in: path
name: host_name
required: true
schema:
type: string
- 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".
- 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)'
in: query
name: source
required: false
Expand Down Expand Up @@ -39218,8 +39217,7 @@ tags:

by a source. For example, some valid sources include nagios, hudson, jenkins,

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).
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.


Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).'
Expand Down
Loading
Loading