GET /Policies/CompatiblePolicies/{requestType}

Lists all policies that are compatible with the specified request type.

get

Authorizations

Path parameters

requestTypeall ofRequired

The type of request for which compatible policies are retrieved.

string · enumOptionalPossible values:

Query parameters

isSystemPolicybooleanOptional

Optional filter to include only system-managed policies (created/managed by Cakewalk).

cursorstringOptional

Optional pagination cursor for fetching the next page of results. Refer to the pagination section in the documentation for usage details.

Header parameters

X-API-SECRETstringRequired

API Secret is used to verify the integrity of the request and authenticate the client. It should be included in all requests. This value must be kept confidential and should never be exposed in client-side code or public repositories.

Example: YOUR_API_SECRET

Responses

200

OK

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /api/v1/Policies/CompatiblePolicies/{requestType} HTTP/1.1
Host: open-api.getcakewalk.io
X-API-KEY: YOUR_API_KEY
X-API-SECRET: YOUR_API_SECRET
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "requestTypes": [
        "text"
      ],
      "tags": [
        "text"
      ],
      "isSystemPolicy": true
    }
  ],
  "links": {
    "self": "text",
    "next": "text"
  }
}