setNetworkPolicy

PUT

/api/v1/agents/{agentId}/network-policy

Takes effect within seconds, without a restart.

setNetworkPolicy

curl --request PUT \
  --url '<base-url>/api/v1/agents/<agentId>/network-policy' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "mode": "open",
  "allow": [
    "string"
  ]
}
'

const url = '<base-url>/api/v1/agents/<agentId>/network-policy';
const options = {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({mode: 'open', allow: ['string']})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "<base-url>/api/v1/agents/<agentId>/network-policy"

payload = {
    "mode": "open",
    "allow": ["string"]
}
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "mode": "open",
  "allow": [
    "string"
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Request body JSON required

mode
open
or
allowlist
required
allow
array of
string
required
Entries like "github.com", ".npmjs.org", "github.com:22", "host:", "1.2.3.0/24:443". Without a port: 80 and 443.

Returns

200

Saved.

JSON

mode
open
or
allowlist
required
allow
array of
string
required
Entries like "github.com", ".npmjs.org", "github.com:22", "host:", "1.2.3.0/24:443". Without a port: 80 and 443.

400

Error.

JSON

error
string
required

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required