Get security policy

Gets policy details with passwords and authentication header values redacted.

Required permission

Account > Networking > SecurityPolicies > Read

Path parameters

Response body

id
string required
pattern
^[A-Za-z0-9-]+$
uid
string required
Permanent identifier for the resource. Unlike `id`, it never changes and is never reused.
min length
24
max length
24
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\\/'"()[\];`%^&*\-_:!]+$
entityType
string required
one of
team, org
spec
(multiple options: anyOf) required
lifecycleStatus
string required
one of
created, pending, error, deleting, deletion_error
createdAt
string required
updatedAt
string required
state
{object}

GET /v1/security-policies/{securityPolicyId}

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

Example response

200 OK

Details about the security policy.

JSON

{
  "data": {
    "uid": "68f0aa1b9c4e2d7f11a3b402"
  }
}