List policies

GET

http://localhost:8080/api/v2/policy

GET

/api/v2/policy

curl http://localhost:8080/api/v2/policy \
     -H "Authorization: Bearer <token>"

{
  "policies": [
    {
      "type": "workspace",
      "meta": {
        "id": "string",
        "createdBy": "string",
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedBy": "string",
        "updatedAt": "2024-01-15T09:30:00Z",
        "scope": "system",
        "name": "my-policy",
        "tenantId": 1001,
        "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
        "projectId": 1,
        "departmentId": "2"
      },
      "status": {
        "clusters": [
          {
            "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
            "status": "Not ready",
            "errorMessage": "string"
          }
        ],
        "validation": {
          "errorMessage": "string"
        }
      },
      "availability": {
        "phase": "Ready",
        "issues": [
          "configuration-issue-1",
          "configuration-issue-2"
        ]
      }
    }
  ]
}

Retrieve a list of all the applied policies.

Authentication

AuthorizationBearer

Bearer authentication

Query parameters

workloadTypeenumOptional

Policy for a specific workload type.

Allowed values:

scopeenumOptional

filter by this scope.

Allowed values:

departmentIdstringOptional

Filter using the department id.

projectIdstringOptional

project id to filter by

clusterIdstringOptionalformat: "uuid"

Filter using the Universally Unique Identifier (UUID) of the cluster.

includeFallbackPoliciesbooleanOptional

whether to include fallback policies in the list. Default to false.

Response

Request completed successfully.

policieslist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error