Skip to content
Ona Docs

DeleteHostAuthenticationToken

client.runners.configurations.hostAuthenticationTokens.delete(HostAuthenticationTokenDeleteParams { id } body, RequestOptionsoptions?): HostAuthenticationTokenDeleteResponse
POST/gitpod.v1.RunnerConfigurationService/DeleteHostAuthenticationToken

Deletes a host authentication token.

Use this method to:

  • Remove unused tokens
  • Revoke access
  • Clean up expired tokens

Examples

  • Delete token:

    Permanently removes a token.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
body: HostAuthenticationTokenDeleteParams { id }
id?: string
formatuuid
ReturnsExpand Collapse
HostAuthenticationTokenDeleteResponse = unknown

DeleteHostAuthenticationToken

import Gitpod from '@gitpod/sdk';

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

const hostAuthenticationToken = await client.runners.configurations.hostAuthenticationTokens.delete(
  { id: 'd2c94c27-3b76-4a42-b88c-95a85e392c68' },
);

console.log(hostAuthenticationToken);
{}
Returns Examples
{}