Get All Scopes

GET {{cb_url}}/containers/v1/orgs/{{cb_org_key}}/guardrails/management/scopes

This request returns the list of scopes configured in the system.
Scopes are used to in order to define a list of resources we want to track.

RBAC Permissions Required

Permission (.notation name)Operation(s)
kubernetes.securityREAD

API Documentation

Response Schema

{
  "items": [
    {
      "scope_id": "<uuid>",
      "scope_name": "<string>",
      "creator": "<string>",
      "created_on": <integer>,
      "modified_by": "<string>",
      "modified_on": <integer>,
      "is_protected": <boolean>,
      "lifecycle_phase": "<string>",
      "clusters_groups": [
        "<string>"
      ],
      "clusters": [
        "<string>"
      ],
      "namespaces": [
        "<string>"
      ],
      "grouping_type": "<string>",
      "workloads_count": <integer>
    }
  ]
}

HEADERS

KeyDatatypeRequiredDescription
X-AUTH-TOKENstring(Required) Carbon Black Access Key
Acceptstring

RESPONSES

status: OK

{&quot;items&quot;:[{&quot;scope_id&quot;:&quot;12a3bc4d-ee56-7f8g-a11b-2345cd67e89e&quot;,&quot;name&quot;:&quot;Updated Demo Scope 01&quot;,&quot;creator&quot;:&quot;&quot;,&quot;created_on&quot;:1683174576876,&quot;created_on_iso&quot;:&quot;2023-05-04T04:29:36.876Z&quot;,&quot;modified_by&quot;:&quot;&quot;,&quot;modified_on&quot;:1683174635458,&quot;modified_on_iso&quot;:&quot;2023-05-04T04:29:36.876Z&quot;,&quot;lifecycle_phase&quot;:&quot;build&quot;,&quot;is_protected&quot;:false,&quot;clusters_groups&quot;:[],&quot;clusters&quot;:[&quot;demo:cluster&quot;],&quot;namespaces&quot;:[&quot;*&quot;],&quot;grouping_type&quot;:&quot;destination&quot;,&quot;workloads_count&quot;:0}]}