Skip to content
Navigation

getNetworkPolicy

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

Authorization

  • session
    optional
    API key in cookie
  • token
    optional
    HTTP Bearer

    Authorization: Bearer <token>

Path parameters

  • agentId
    string
    required

Returns

200

The agent's network policy.

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.

404

Error.
JSON
  • error
    string
    required

Type to search…

↑↓ navigate↵ selectEsc close