> ## 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.

# Get Security Policy

> Gets details about a specific security policy.

`Unary` · [`Security`](/docs/api-reference/generated/security/overview)

Gets details about a specific security policy.

Use this method to:

* View security policy configuration
* Inspect enforcement rules

### Examples

* Get security policy:

  Retrieves a security policy by ID.

  ```yaml theme={null}
  securityPolicyId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  ```

## Endpoint

```text theme={null}
POST /api/gitpod.v1.SecurityService/GetSecurityPolicy
```

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.SecurityService/GetSecurityPolicy" \
    --header "Authorization: Bearer $ONA_API_KEY" \
    --header "Content-Type: application/json" \
    --data '{
    "securityPolicyId": "https://example.com"
  }'
  ```

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

  ona = create_client_from_env()
  request = security_pb2.GetSecurityPolicyRequest(
      security_policy_id="https://example.com",
  )
  response = ona.services.security.get_security_policy(request)
  print(response)
  ```

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

  async function main() {
    const ona = createClientFromEnv();
    const request = create(GetSecurityPolicyRequestSchema, {
      securityPolicyId: "https://example.com",
    });
    const response = await ona.services.security.getSecurityPolicy(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.GetSecurityPolicyRequest{
  		SecurityPolicyId: "https://example.com",
  	})
  	response, err := ona.Services.Security.GetSecurityPolicy(context.Background(), request)
  	if err != nil {
  		log.Fatal(err)
  	}
  	fmt.Println(response.Msg)
  }
  ```

  ```json Request body theme={null}
  {
    "securityPolicyId": "https://example.com"
  }
  ```
</CodeGroup>

## Request

`gitpod.v1.GetSecurityPolicyRequest`

| Field              | Type   | Required | Description                      |
| ------------------ | ------ | -------- | -------------------------------- |
| `securityPolicyId` | string | No       | Constraints: `string.uuid=true`. |

## Response

`gitpod.v1.GetSecurityPolicyResponse`

| Field            | Type                                              | Required | Description                   |
| ---------------- | ------------------------------------------------- | -------- | ----------------------------- |
| `securityPolicy` | [SecurityPolicy](#type-gitpod-v1-security-policy) | Yes      | Constraints: `required=true`. |

## Related types

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

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

  | Field            | Type                                                 | Required | Description                      |
  | ---------------- | ---------------------------------------------------- | -------- | -------------------------------- |
  | `id`             | string                                               | No       | Constraints: `string.uuid=true`. |
  | `metadata`       | [Metadata](#type-gitpod-v1-security-policy-metadata) | Yes      | Constraints: `required=true`.    |
  | `spec`           | [Spec](#type-gitpod-v1-security-policy-spec)         | Yes      | Constraints: `required=true`.    |
  | `organizationId` | string                                               | No       | Constraints: `string.uuid=true`. |
  | `createdAt`      | RFC 3339 timestamp                                   | No       |                                  |
  | `updatedAt`      | RFC 3339 timestamp                                   | No       |                                  |
</Accordion>

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

<Accordion title="Metadata">
  `gitpod.v1.SecurityPolicy.Metadata`

  | Field  | Type   | Required | Description                                         |
  | ------ | ------ | -------- | --------------------------------------------------- |
  | `name` | string | No       | Constraints: `string.max_len=80, string.min_len=1`. |
</Accordion>

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

<Accordion title="Spec">
  `gitpod.v1.SecurityPolicy.Spec`

  | Field         | Type             | Required | Description                                            |
  | ------------- | ---------------- | -------- | ------------------------------------------------------ |
  | `ports`       | PortPolicy       | No       |                                                        |
  | `executables` | ExecutablePolicy | No       | executables is the public Veto Exec GA policy surface. |
</Accordion>