Skip to main content
PATCH

Price

Free. See Pricing.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policy_id
string
required

Body

application/json
name
string
Required string length: 1 - 100
defaultAction
enum<string>
Available options:
allow,
block
allow
object
block
object

Response

The policy.

success
any
required
creditsUsed
integer
required
costUsd
number
required

What this call cost, in dollars.

requestId
string
required
id
string<uuid>
name
string
defaultAction
enum<string>

What happens to a domain that no list entry matches.

Available options:
allow,
block
allow
object
block
object
version
integer

Starts at 1 and goes up by 1 with each update.

createdAt
string<date-time>
updatedAt
string<date-time>
runningSessions
integer

Running browser sessions that use the policy, applied or pending.

appliedSessions
integer

How many of them now enforce this version. A session that is still on an older version shows that in networkPolicyVersion.

pendingSessionIds
string[]

Sessions this call could not reach yet. They still enforce an older version.

closedConnections
integer

Open connections to hosts the new version blocks, closed in those sessions.