Get policy | Check Point AI Security

{
  "policy": {
    "policy_id": "policy-123456-random-g74j7",
    "version_id": 3,
    "name": "string",
    "default_threshold": "l1_confident",
    "detectors": [
      {
        "type": "prompt_attack",
        "location": "user::content",
        "allowed_domains": [
          "my-trusted-domain.com",
          "another-safe-domain.com"
        ],
        "override_list": [
          "deny_list_item1",
          "deny_list_item2"
        ],
        "tool_access_action": "allow",
        "tool_access_list": [
          "get_weather"
        ],
        "allowed_tools": [
          {
            "tool_name": "string",
            "tool_matcher": "string"
          }
        ]
      }
    ],
    "custom_guardrails": [
      {
        "id": "custom-guardrail-123456-random-g74j7",
        "locations": [
          "user::content"
        ]
      }
    ],
    "updated_at": "2024-01-15T09:30:00Z",
    "projects": [
      {
        "id": "string",
        "name": "string",
        "action": "detect"
      }
    ]
  }
}

Retrieve a single policy, including the projects currently using it

Authentication

AuthorizationBearer

Bearer authentication using API key. Generate an API key from the AI Guardrails Dashboard. Example: Bearer sk_123...

Keys carry one of two access scopes, chosen when the key is created:

Read and write — may call every endpoint. This is the default, and the scope of every key created before scopes were introduced.
Read only — may call read endpoints such as /v1-beta/logs, /v1-beta/analytics and the GET endpoints. Write endpoints return 403.

Issue a read-only key to anything that only needs to retrieve data, such as a log-shipping job or a dashboard, so that it cannot modify your policies or projects.

Path parameters

policyIdstringRequired

Response

Policy details

policyobject

A policy as returned by the API

Errors

403

Forbidden Error

404

Not Found Error