Skip to content
Ona API Reference
Ona Docs
API Reference
Runners
Policies

DeleteRunnerPolicy

client.runners.policies.delete(PolicyDeleteParams { groupId, runnerId } body, RequestOptionsoptions?): PolicyDeleteResponse
POST/gitpod.v1.RunnerService/DeleteRunnerPolicy

Deletes a runner policy.

Use this method to:

  • Remove access controls
  • Revoke permissions
  • Clean up policies

Examples

  • Delete policy:

    Removes a group’s access policy.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
ParametersExpand Collapse
body: PolicyDeleteParams { groupId, runnerId }
groupId?: string

group_id specifies the group_id identifier

formatuuid
runnerId?: string

runner_id specifies the project identifier

formatuuid
ReturnsExpand Collapse
PolicyDeleteResponse = unknown

DeleteRunnerPolicy

import Gitpod from '@gitpod/sdk';

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

const policy = await client.runners.policies.delete({
  groupId: 'f53d2330-3795-4c5d-a1f3-453121af9c60',
  runnerId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

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