Skip to content
Ona API Reference
Ona Docs
API Reference
Runners

CreateRunnerLogsToken

runners.create_logs_token(RunnerCreateLogsTokenParams**kwargs) -> RunnerCreateLogsTokenResponse
POST/gitpod.v1.RunnerService/CreateRunnerLogsToken

Creates an access token for runner logs and debug information.

Generated tokens are valid for one hour and provide runner-specific access permissions. The token is scoped to a specific runner and can be used to access support bundles.

Examples

  • Generate runner logs token:

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
runner_id: Optional[str]

runner_id specifies the runner for which the logs token should be created.

+required

formatuuid
ReturnsExpand Collapse
class RunnerCreateLogsTokenResponse: …
access_token: str

access_token is the token that can be used to access the logs and support bundle of the runner

CreateRunnerLogsToken

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_logs_token(
    runner_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(response.access_token)
{
  "accessToken": "accessToken"
}
Returns Examples
{
  "accessToken": "accessToken"
}