Team / Network Policies /

Update network policy

Updates an existing network policy.

Required permission

Account > Networking > NetworkPolicies > Update

Path parameters

networkPolicyId
string required
ID of the network policy

Request body

{object}

name
string
The name of the network policy.
min length
3
max length
39
pattern
^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$
description
string
The description of the network policy.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
spec
{object}

API

CLI

JS Client

PATCH /v1/network-policies/{networkPolicyId}

PATCH /v1/teams/{teamId}/network-policies/{networkPolicyId}

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"name":"restrict-api-ingress","description":"Restrict ingress to the api service."}' \
  https://api.northflank.com/v1/network-policies/{networkPolicyId}

Example response

200 OK

success