diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index ef45455ea28..517f85275c4 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -1148,6 +1148,19 @@ menu: url: /api/latest/key-management/ identifier: key-management generated: true + - name: Validate API key + url: '#validate-api-key' + identifier: key-management-validate-api-key + parent: key-management + generated: true + params: + versions: + - v2 + operationids: + - Validate + unstable: + - v2 + order: 20 - name: Update a personal access token url: '#update-a-personal-access-token' identifier: key-management-update-a-personal-access-token diff --git a/content/en/api/v2/key-management/examples.json b/content/en/api/v2/key-management/examples.json index 444a5e589fe..221d607653d 100644 --- a/content/en/api/v2/key-management/examples.json +++ b/content/en/api/v2/key-management/examples.json @@ -1886,5 +1886,56 @@ }, "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Object used to update a personal access token.

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

attributes [required]

\n
\n

object

\n

Attributes used to update a personal access token.

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

name

\n
\n

string

\n

Name of the personal access token.

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

scopes

\n
\n

[string]

\n

Array of scopes to grant the personal access token.

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

id [required]

\n
\n

string

\n

ID of the personal access token.

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

type [required]

\n
\n

enum

\n

Personal access tokens resource type. \nAllowed enum values: personal_access_tokens

default: personal_access_tokens

\n
\n \n
\n
\n
\n
" } + }, + "Validate": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "api_key_id": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6", + "api_key_scopes": [ + "remote_config_read" + ], + "valid": true + }, + "id": "550e8400-e29b-41d4-a716-446655440000", + "type": "validate_v2" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data object containing the API key validation result.

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

attributes [required]

\n
\n

object

\n

Attributes of the API key validation response.

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

api_key_id [required]

\n
\n

string

\n

The UUID of the API key.

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

api_key_scopes [required]

\n
\n

[string]

\n

List of scope names associated with the API key.

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

valid [required]

\n
\n

boolean

\n

Whether the API key is valid.

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

id [required]

\n
\n

string

\n

The UUID of the organization associated with the API key.

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

type [required]

\n
\n

enum

\n

Resource type for the API key validation response. \nAllowed enum values: validate_v2

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

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

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

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

meta

\n
\n

object

\n

Non-standard meta-information about the error

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

source

\n
\n

object

\n

References to the source of the error.

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

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

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

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

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

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

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

status

\n
\n

string

\n

Status code of the response.

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

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } } } \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 06e77554827..a38b87d725a 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -82197,6 +82197,61 @@ components: description: The title of the event. example: "The event title" type: string + ValidateV2Attributes: + description: Attributes of the API key validation response. + properties: + api_key_id: + description: The UUID of the API key. + example: "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6" + type: string + api_key_scopes: + description: List of scope names associated with the API key. + example: + - "remote_config_read" + items: + type: string + type: array + valid: + description: Whether the API key is valid. + example: true + type: boolean + required: + - valid + - api_key_scopes + - api_key_id + type: object + ValidateV2Data: + description: Data object containing the API key validation result. + properties: + attributes: + $ref: "#/components/schemas/ValidateV2Attributes" + id: + description: The UUID of the organization associated with the API key. + example: "550e8400-e29b-41d4-a716-446655440000" + type: string + type: + $ref: "#/components/schemas/ValidateV2Type" + required: + - id + - type + - attributes + type: object + ValidateV2Response: + description: Response for the API key validation endpoint. + properties: + data: + $ref: "#/components/schemas/ValidateV2Data" + required: + - data + type: object + ValidateV2Type: + description: Resource type for the API key validation response. + enum: + - validate_v2 + example: validate_v2 + type: string + x-enum-varnames: + - ValidateV2 ValidationError: description: Represents a single validation error, including a human-readable title and metadata. properties: @@ -146308,6 +146363,48 @@ paths: operator: OR permissions: - teams_read + /api/v2/validate: + get: + description: Check if the API key is valid. Returns the organization UUID, API key ID, and associated scopes. + operationId: Validate + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + api_key_id: "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6" + api_key_scopes: + - "remote_config_read" + valid: true + id: "550e8400-e29b-41d4-a716-446655440000" + type: "validate_v2" + schema: + $ref: "#/components/schemas/ValidateV2Response" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + security: + - apiKeyAuth: [] + summary: Validate API key + tags: + - Key Management + x-menu-order: 20 + "x-permission": + operator: OPEN + permissions: [] + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/widgets/{experience_type}: get: description: |- diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index aa8902f5d00..53e39be88e6 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -4987,6 +4987,10 @@ "description": "Get a list of memberships for a user", "summary": "Get user memberships" }, + "Validate": { + "description": "Check if the API key is valid. Returns the organization UUID, API key ID, and associated scopes.", + "summary": "Validate API key" + }, "SearchWidgets": { "description": "Search and list widgets for a given experience type, with filtering, sorting, and pagination.\n\n**Response meta** carries totals scoped to the current filter:\n- `filtered_total` — widgets matching the filter.\n- `created_by_you_total` — among the matches, how many the current user created.\n- `favorited_by_you_total` — among the matches, how many the current user has favorited.\n- `created_by_anyone_total` — total widgets in the experience type, ignoring filters.\n\nEach returned widget includes `is_favorited` reflecting the current user's favorite status.\nFavoriting itself is performed through the shared favorites API, not this endpoint.", "summary": "Search widgets"