Get security policy spec

Gets editable name, description and complete spec, including Basic Auth passwords and authentication header values. Requires readSpec permission.

Required permission

Account > Networking > SecurityPolicies > Read Spec

Path parameters

securityPolicyId
string required
ID of the security policy

Response body

{object}
Response object.

data
{object} required
Result data.

name
string required
min length
3
max length
39
pattern
^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
spec
(multiple options: anyOf) required

GET /v1/security-policies/{securityPolicyId}/spec

GET /v1/teams/{teamId}/security-policies/{securityPolicyId}/spec

Example response

200 OK

Editable configuration including authentication values.

JSON

{
  "data": {
    "spec": {
      "securityPolicies": {
        "orPolicies": {
          "headers": [
            {
              "regexMode": false,
              "name": "headerName",
              "value": "headerValue"
            }
          ]
        },
        "requiredPolicies": {
          "headers": [
            {
              "regexMode": false,
              "name": "headerName",
              "value": "headerValue"
            }
          ]
        }
      }
    }
  }
}