CreatePrebuildLogsToken

client.prebuilds.createLogsToken(, ?): PrebuildCreateLogsTokenResponse { accessToken }

POST/gitpod.v1.PrebuildService/CreatePrebuildLogsToken

Creates a logs access token for a prebuild.

Use this method to:

Stream logs from a running prebuild
Access archived logs from completed prebuilds

Generated tokens are valid for one hour.

Examples

Create prebuild logs token:

Generates a token for accessing prebuild logs.
```
prebuildId: "07e03a28-65a5-4d98-b532-8ea67b188048"
```

ParametersExpand Collapse

body: PrebuildCreateLogsTokenParams { prebuildId }

prebuildId: string

prebuild_id specifies the prebuild for which the logs token should be created.

+required

formatuuid

ReturnsExpand Collapse

PrebuildCreateLogsTokenResponse { accessToken }

accessToken: string

access_token is the token that can be used to access the logs of the prebuild

CreatePrebuildLogsToken

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.prebuilds.createLogsToken({
  prebuildId: '07e03a28-65a5-4d98-b532-8ea67b188048',
});

console.log(response.accessToken);

{
  "accessToken": "accessToken"
}

Returns Examples

{
  "accessToken": "accessToken"
}