> ## Documentation Index
> Fetch the complete documentation index at: https://ona.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Runner Policies

> Lists policies for a runner.

`Unary` · [`Runners`](/docs/api-reference/generated/runner/overview)

Lists policies for a runner.

Use this method to:

* View access controls
* Check policy configurations
* Audit permissions

### Examples

* List policies:

  Shows all policies for a runner.

  ```yaml theme={null}
  runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  pagination:
    pageSize: 20
  ```

## Endpoint

```text theme={null}
POST /api/gitpod.v1.RunnerService/ListRunnerPolicies
```

Send a Bearer token as described in [Authentication](/docs/api-reference#authenticate-requests). If your organization uses a custom management-plane domain, replace `https://app.ona.com` with that domain.

## Request example

<CodeGroup>
  ```bash cURL theme={null}
  export ONA_HOST=https://app.ona.com
  export ONA_API_KEY=<your-token>

  curl --request POST \
    --url "$ONA_HOST/api/gitpod.v1.RunnerService/ListRunnerPolicies" \
    --header "Authorization: Bearer $ONA_API_KEY" \
    --header "Content-Type: application/json" \
    --data '{
    "pagination": {
      "pageSize": 1
    }
  }'
  ```

  ```python Python theme={null}
  import gitpod.v1.pagination_pb2 as pagination_pb2
  import gitpod.v1.runner_pb2 as runner_pb2
  from ona_sdk import create_client_from_env

  ona = create_client_from_env()
  request = runner_pb2.ListRunnerPoliciesRequest(
      pagination=pagination_pb2.PaginationRequest(
          page_size=1,
      ),
  )
  response = ona.services.runner.list_runner_policies(request)
  print(response)
  ```

  ```typescript TypeScript theme={null}
  import { create } from "@bufbuild/protobuf";
  import { createClientFromEnv } from "@gitpod/sdk";
  import { ListRunnerPoliciesRequestSchema } from "@gitpod/sdk/gitpod/v1/runner_pb";

  async function main() {
    const ona = createClientFromEnv();
    const request = create(ListRunnerPoliciesRequestSchema, {
      pagination: {
        pageSize: 1,
      },
    });
    const response = await ona.services.runner.listRunnerPolicies(request);
    console.log(response);
  }

  main().catch(console.error);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"log"

  	"connectrpc.com/connect"
  	"github.com/gitpod-io/gitpod-sdk-go/sdk"
  	gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
  )

  func main() {
  	ona, err := sdk.NewFromEnv()
  	if err != nil {
  		log.Fatal(err)
  	}

  	request := connect.NewRequest(&gitpodpb.ListRunnerPoliciesRequest{
  		Pagination: &gitpodpb.PaginationRequest{
  			PageSize: 1,
  		},
  	})
  	response, err := ona.Services.Runner.ListRunnerPolicies(context.Background(), request)
  	if err != nil {
  		log.Fatal(err)
  	}
  	fmt.Println(response.Msg)
  }
  ```

  ```json Request body theme={null}
  {
    "pagination": {
      "pageSize": 1
    }
  }
  ```
</CodeGroup>

## Request

`gitpod.v1.ListRunnerPoliciesRequest`

ListRunnerPoliciesRequest lists policies for a project.

| Field        | Type                                                    | Required | Description                                                                  |
| ------------ | ------------------------------------------------------- | -------- | ---------------------------------------------------------------------------- |
| `pagination` | [PaginationRequest](#type-gitpod-v1-pagination-request) | No       | pagination contains the pagination options for listing project policies      |
| `runnerId`   | string                                                  | No       | runner\_id specifies the project identifier Constraints: `string.uuid=true`. |

## Response

`gitpod.v1.ListRunnerPoliciesResponse`

| Field        | Type                                                      | Required | Description |
| ------------ | --------------------------------------------------------- | -------- | ----------- |
| `pagination` | [PaginationResponse](#type-gitpod-v1-pagination-response) | No       |             |
| `policies`   | array of [RunnerPolicy](#type-gitpod-v1-runner-policy)    | No       |             |

## Related types

<a id="type-gitpod-v1-pagination-request" />

<Accordion title="PaginationRequest">
  `gitpod.v1.PaginationRequest`

  | Field      | Type    | Required | Description                                                                                                                              |
  | ---------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
  | `pageSize` | integer | No       | Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. Constraints: `int32.gte=0, int32.lte=100`. |
  | `token`    | string  | No       | Token for the next set of results that was returned as next\_token of a PaginationResponse                                               |
</Accordion>

<a id="type-gitpod-v1-pagination-response" />

<Accordion title="PaginationResponse">
  `gitpod.v1.PaginationResponse`

  | Field       | Type   | Required | Description                                                                             |
  | ----------- | ------ | -------- | --------------------------------------------------------------------------------------- |
  | `nextToken` | string | No       | Token passed for retrieving the next set of results. Empty if there are no more results |
</Accordion>

<a id="type-gitpod-v1-runner-policy" />

<Accordion title="RunnerPolicy">
  `gitpod.v1.RunnerPolicy`

  | Field     | Type                                      | Required | Description                            |
  | --------- | ----------------------------------------- | -------- | -------------------------------------- |
  | `groupId` | string                                    | No       | Constraints: `string.uuid=true`.       |
  | `role`    | [RunnerRole](#enum-gitpod-v1-runner-role) | No       | role is the role assigned to the group |
</Accordion>

<a id="enum-gitpod-v1-runner-role" />

<Accordion title="RunnerRole">
  | Value                     | Number | Description |
  | ------------------------- | -----: | ----------- |
  | `RUNNER_ROLE_UNSPECIFIED` |      0 |             |
  | `RUNNER_ROLE_ADMIN`       |      1 |             |
  | `RUNNER_ROLE_USER`        |      2 |             |
</Accordion>