Create security policy

Creates a policy for the team or organization. Specify spec.enabled explicitly. Organization warning acknowledgements contain only code, winningDefaultPolicyId and shadowedEnforcedPolicyIds from the current 409 warnings.

Required permission

Account > Networking > SecurityPolicies > Create

Request body

(multiple options: anyOf)

{object}

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
{object} required

{object}

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
{object} required
warningAcknowledgements
[array]

{object}

code
string required
one of
defaultOverrodeEnforced
winningDefaultPolicyId
string required
shadowedEnforcedPolicyIds
[array] required

string

Response body

{object}
Response object.

data
{object} required
Result data.

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}

lastSyncAttemptAt
string
lastSyncedAt
string
counts
{object}

matched
integer required
excluded
integer required
unsupported
integer required
pending
integer required
inSync
integer required
error
integer required

warnings
[array]

{object}

code
string required
one of
defaultOverrodeEnforced
winningDefaultPolicyId
string required
shadowedEnforcedPolicyIds
[array] required

string

affectedCount
integer required
risk
string required
one of
nestedDelegation, broadeningDelegation

POST /v1/security-policies

POST /v1/teams/{teamId}/security-policies

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"spec":{"securityPolicies":{"orPolicies":{"headers":[{"regexMode":false,"name":"headerName","value":"headerValue"}]},"requiredPolicies":{"headers":[{"regexMode":false,"name":"headerName","value":"headerValue"}]}},"enabled":false,"priority":0,"paths":[{"path":"string","matchMode":"exact"}],"accessMode":"protected","targets":{"projects":{"mode":"all","ids":[]},"workloads":{"mode":"all","items":[]},"tags":{"enabled":false,"items":[],"matchCondition":"or"}},"exclusions":{"projects":[],"workloads":[]}},"name":"string"}' \
  https://api.northflank.com/v1/security-policies

Example response

200 OK

The created policy with authentication values redacted.

JSON

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