CreateRunnerToken

runners.create_runner_token() -> RunnerCreateRunnerTokenResponse

POST/gitpod.v1.RunnerService/CreateRunnerToken

Creates a new authentication token for a runner.

Use this method to:

Generate runner credentials
Renew expired tokens
Set up runner authentication

Note: This does not expire previously issued tokens.

Examples

Create token:

Creates a new token for runner authentication.
```
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

ParametersExpand Collapse

runner_id: Optional[str]

formatuuid

ReturnsExpand Collapse

class RunnerCreateRunnerTokenResponse: …

Deprecatedaccess_token: Optional[str]

deprecated, will be removed. Use exchange_token instead.

exchange_token: Optional[str]

exchange_token is a one-time use token that should be exchanged by the runner for an access token, using the IdentityService.ExchangeToken rpc. The token expires after 24 hours.

CreateRunnerToken

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.runners.create_runner_token(
    runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(response.access_token)

{
  "accessToken": "accessToken",
  "exchangeToken": "exchangeToken"
}

Returns Examples

{
  "accessToken": "accessToken",
  "exchangeToken": "exchangeToken"
}