Get Policy

GET {{cb_url}}/containers/v1/orgs/{{cb_org_key}}/guardrails/management/policies/{{cb_container_policy_id}}

Get the policy details for the specified policy id.

RBAC Permissions Required

API Documentation

Response Schema

{
    "scope_metadata": {
        "scope_id": "<uuid>",
        "scope_name": "<string>"
    },
    "creator": "<string>",
    "policy_id": "<uuid>",
    "name": "<string>",
    "status": "<string>",
    "rules": [
        {
            "id": "<string>",
            "action": "<string>",
            "is_enabled": <boolean>,
            "preset_id": "<string>",
            "preset_name": "<string>"
        }
    ],
    "exceptions": {
        "ruleId1": [
            {
                "name": "<string>",
                "username": "<string>",
                "labels": [
                    {
                        "key": "<string>",
                        "value": "<string>"
                    }
                ]
            }
        ]
    },
    "include_init_containers": <boolean>,
    "include_ephemeral_containers": <boolean>
}

HEADERS

RESPONSES

status: OK

{"policy_id":"12a345cde-0a9b-464a-804e-0cbb3201c68f","name":"demo-policy","scope_metadata":{"scope_id":"123456a7-a607-4377-8ca3-d1020ad8fb85","scope_name":"sample-scope"},"creator":"demouser@demoorg.com","created_on":1631168658409,"created_on_iso":"2021-09-09T06:24:18.409Z","modified_by":"demouser@demoorg.com","modified_on":1655988483580,"modified_on_iso":"2022-06-23T12:48:03.58Z","rules":[{"id":"demo-rule","action":"alert","is_enabled":true}],"exceptions":{},"include_init_containers":false,"include_ephemeral_containers":true,"status":"enabled"}