Api token

Api Token

get

Generate an API token for the current user.

Use this endpoint to generate an API token for the current user. Two types of API tokens are supported:

• Generic API token: This token is short-lived and can be used for generic automation tasks. The expiration can be set by the user, but the server will impose a maximum expiration time.
• Workload API token: This token is scoped to a specific pipeline run, step run or schedule and is used by pipeline workloads to authenticate with the server. A pipeline run ID, step run ID or schedule ID must be provided and the generated token will only be valid for the indicated pipeline run, step run or schedule. No time limit is imposed on the validity of the token. A workload API token can be used to authenticate and generate another workload API token, but only for the same schedule, pipeline run ID or step run ID, in that order.

Args: token_type: The type of API token to generate. expires_in: The expiration time of the generic API token in seconds. If not set, the server will use the default expiration time for generic API tokens. The server also imposes a maximum expiration time. schedule_id: The ID of the schedule to scope the workload API token to. pipeline_run_id: The ID of the pipeline run to scope the workload API token to. auth_context: The authentication context.

Returns: The API token.

Raises: AuthorizationException: If not authorized to generate the API token. ValueError: If the request is invalid.

Authorizations

Query parameters

token_typestring · enumOptional

The API token type.

Default: genericAvailable options:

expires_inany ofOptional

schedule_idany ofOptional

pipeline_run_idany ofOptional

Responses

application/json

stringOptional

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/api_token HTTP/1.1
Host: 
Accept: */*

text