v2

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-26192307950.1 KB
auth

Api Token

Get a workload API token for the current user.

Args: pipeline_id: The ID of the pipeline to get the API token for. schedule_id: The ID of the schedule to get the API token for. expires_minutes: The number of minutes for which the API token should be valid. If not provided, the API token will be valid indefinitely. auth_context: The authentication context.

Returns: The API token.

Raises: HTTPException: If the user is not authenticated. AuthorizationException: If trying to scope the API token to a different pipeline/schedule than the token used to authorize this request.

get/api/v1/api_token

Query parameters

pipeline_idstring uuid nullable
schedule_idstring uuid nullable
expires_minutesinteger nullable

Response

Successful Response

string required