Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
289 changes: 289 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1291,6 +1291,152 @@ components:
type: string
x-enum-varnames:
- CHECK_STATUS
ClientToken:
description: 'Client token object. Client tokens (also known as public API keys)
enable you to submit

data from your browser or mobile applications to Datadog.'
properties:
created_at:
description: Creation timestamp of the client token.
example: '2024-03-15T10:30:00.000000+00:00'
format: date-time
readOnly: true
type: string
created_by_handle:
description: Handle of the user who created the client token.
example: user@example.com
readOnly: true
type: string
created_by_uuid:
description: UUID of the user who created the client token.
example: 00000000-0000-0000-0000-000000000000
format: uuid
readOnly: true
type: string
disabled_at:
description: Timestamp when the client token was disabled.
example: '2024-03-20T10:30:00.000000+00:00'
format: date-time
nullable: true
readOnly: true
type: string
disabled_by:
description: ID of the user who disabled the client token.
format: int64
readOnly: true
type: integer
disabled_by_handle:
description: Handle of the user who disabled the client token.
example: user@example.com
readOnly: true
type: string
hash:
description: 'The hash value of the client token. This is the secret token
value that should be

used in your browser or mobile application.'
example: 1234567890abcdef1234567890abcdef123
maxLength: 35
readOnly: true
type: string
modified_by:
description: ID of the user who last modified the client token.
format: int64
readOnly: true
type: integer
name:
description: Name of the client token.
example: Example Client Token
maxLength: 255
minLength: 1
type: string
org_id:
description: Organization ID associated with the client token.
example: 12345
format: int64
readOnly: true
type: integer
origin_urls:
description: 'List of allowed origin URLs for browser-based applications.
Requests from URLs

not in this list will be rejected.'
example:
- https://example.com
items:
example: https://example.com
maxLength: 2500
type: string
maxItems: 100
type: array
required:
- origin_urls
type: object
ClientTokenCreateRequest:
description: Request to create a new client token.
properties:
name:
description: Name of the client token.
example: Example Client Token
maxLength: 255
minLength: 1
type: string
origin_urls:
description: 'List of allowed origin URLs for browser-based applications.
Requests from URLs

not in this list will be rejected.'
example:
- https://example.com
items:
example: https://example.com
maxLength: 2500
type: string
maxItems: 100
type: array
required:
- name
- origin_urls
type: object
ClientTokenRevokeRequest:
description: Request to revoke a client token.
properties:
hash:
description: Hash value of the client token to revoke.
example: 1234567890abcdef1234567890abcdef123
maxLength: 35
type: string
required:
- hash
type: object
ClientTokenUpdateRequest:
description: Request to update an existing client token.
properties:
hash:
description: Hash value of the client token to update.
example: 1234567890abcdef1234567890abcdef123
maxLength: 35
type: string
name:
description: New name for the client token.
example: Updated Client Token Name
maxLength: 255
minLength: 1
type: string
origin_urls:
description: New list of allowed origin URLs. If provided, this will replace
the existing list.
items:
example: https://example.com
maxLength: 2500
type: string
maxItems: 100
type: array
required:
- hash
- name
type: object
ContentEncoding:
description: HTTP header used to compress the media-type.
enum:
Expand Down Expand Up @@ -26206,6 +26352,7 @@ components:
ci_visibility_pipelines_write: Create CI Visibility pipeline spans using
the API.
ci_visibility_read: View CI Visibility.
client_tokens_write: Create, edit, and delete client tokens.
cloud_cost_management_read: View Cloud Cost pages and the cloud cost data
source in dashboards and notebooks. For more details, see the Cloud
Cost Management docs.
Expand Down Expand Up @@ -33294,6 +33441,148 @@ paths:
tags:
- Organizations
x-codegen-request-body-name: body
/api/v1/public_api_key:
delete:
description: 'Revoke a client token (public API key). Once revoked, the token
can no longer be used

to submit data to Datadog.'
operationId: RevokeClientToken
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientTokenRevokeRequest'
required: true
responses:
'204':
description: No Content
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- client_tokens_write
summary: Revoke client token
tags:
- Key Management
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is in public beta and is subject to change.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
post:
description: 'Create a new client token (public API key) to submit data from
your browser or mobile

applications to Datadog.'
operationId: CreateClientToken
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientTokenCreateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClientToken'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- client_tokens_write
summary: Create client token
tags:
- Key Management
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is in public beta and is subject to change.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
put:
description: Update the name and/or origin URLs of an existing client token
(public API key).
operationId: UpdateClientToken
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientTokenUpdateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ClientToken'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- client_tokens_write
summary: Update client token
tags:
- Key Management
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is in public beta and is subject to change.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v1/query:
get:
description: Query timeseries points.
Expand Down
Loading
Loading