Skip to content
Ona API Reference
Ona Docs
API Reference
Runners

Policies

CreateRunnerPolicy
client.runners.policies.create(PolicyCreateParams { groupId, role, runnerId } body, RequestOptionsoptions?): PolicyCreateResponse { policy }
POST/gitpod.v1.RunnerService/CreateRunnerPolicy
DeleteRunnerPolicy
client.runners.policies.delete(PolicyDeleteParams { groupId, runnerId } body, RequestOptionsoptions?): PolicyDeleteResponse
POST/gitpod.v1.RunnerService/DeleteRunnerPolicy
ListRunnerPolicies
client.runners.policies.list(PolicyListParams { token, pageSize, pagination, runnerId } params, RequestOptionsoptions?): PoliciesPage<RunnerPolicy { groupId, role } >
POST/gitpod.v1.RunnerService/ListRunnerPolicies
UpdateRunnerPolicy
client.runners.policies.update(PolicyUpdateParams { groupId, role, runnerId } body, RequestOptionsoptions?): PolicyUpdateResponse { policy }
POST/gitpod.v1.RunnerService/UpdateRunnerPolicy
ModelsExpand Collapse
RunnerPolicy { groupId, role }
groupId?: string
formatuuid
role?: RunnerRole

role is the role assigned to the group

One of the following:
"RUNNER_ROLE_UNSPECIFIED"
"RUNNER_ROLE_ADMIN"
"RUNNER_ROLE_USER"
RunnerRole = "RUNNER_ROLE_UNSPECIFIED" | "RUNNER_ROLE_ADMIN" | "RUNNER_ROLE_USER"
One of the following:
"RUNNER_ROLE_UNSPECIFIED"
"RUNNER_ROLE_ADMIN"
"RUNNER_ROLE_USER"
PolicyCreateResponse { policy }
policy: RunnerPolicy { groupId, role }
groupId?: string
formatuuid
role?: RunnerRole

role is the role assigned to the group

One of the following:
"RUNNER_ROLE_UNSPECIFIED"
"RUNNER_ROLE_ADMIN"
"RUNNER_ROLE_USER"
PolicyDeleteResponse = unknown
PolicyUpdateResponse { policy }
policy: RunnerPolicy { groupId, role }
groupId?: string
formatuuid
role?: RunnerRole

role is the role assigned to the group

One of the following:
"RUNNER_ROLE_UNSPECIFIED"
"RUNNER_ROLE_ADMIN"
"RUNNER_ROLE_USER"