Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeSandboxes

Get an API key's sandbox network policy

The layer over the sandboxes an API key creates, and the bundle's version. A key with no layer answers the version and no layer. Network policy access must be enabled for the organization. Host egress, DNS and bandwidth enforcement is not yet available. Creates requiring an unsupported restriction return 503 NETWORK_POLICY_UNSUPPORTED. Only the organization layer's preview source restrictions are enforced. Host policy updates are not pushed to running sandboxes. The router applies updated organization preview restrictions on each new request, including previews of existing sandboxes, after receiving the new policy version.

Required permission

Requires the sandboxes.network_read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

Guided workflow: orl sandbox network-policy get

orl sandbox network-policy get --key <key>
GET
/v1/sandbox-network-policy/keys/{keyId}

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

keyId*string

Response Body

The key's layer

application/json
  1. response
version*integer

The policy's version. Send it as expectedVersion on a write.

Formatint64
layer?

One level's network policy. A missing field restricts nothing. Every level (organization, user, key, sandbox) is a ceiling on the ones below it: a destination is reachable only if every layer admits it.

defaults?

The organization's only. The sandbox layer of a create that names neither network nor egress.

updatedAt?string
Formatdate-time
updatedBy?string

user: for a session, key: for an API key.

Example Request
curl -X GET 'https://api.openrelay.inc/v1/sandbox-network-policy/keys/string'
Example Response
{  "version": 0,  "layer": {    "egress": {      "mode": "open",      "allow": [        {          "cidr": "string",          "domain": "string",          "protocol": "any",          "ports": [            0          ]        }      ],      "deny": [        {          "cidr": "string",          "domain": "string",          "protocol": "any",          "ports": [            0          ]        }      ]    },    "dns": {      "blockBypass": true    },    "ingress": {      "previewSources": [        "string"      ]    },    "bandwidth": {      "egressMbps": 0,      "ingressMbps": 0    }  },  "defaults": {    "egress": {      "mode": "open",      "allow": [        {          "cidr": "string",          "domain": "string",          "protocol": "any",          "ports": [            0          ]        }      ],      "deny": [        {          "cidr": "string",          "domain": "string",          "protocol": "any",          "ports": [            0          ]        }      ]    },    "dns": {      "blockBypass": true    },    "ingress": {      "previewSources": [        "string"      ]    },    "bandwidth": {      "egressMbps": 0,      "ingressMbps": 0    }  },  "updatedAt": "2019-08-24T14:15:22Z",  "updatedBy": "string"}

Replace a member's sandbox network policy PUT

Replaces a member's sandbox network layer using the version the policy was read at. An API key may only narrow the layer. Network policy access must be enabled for the organization. Host egress, DNS and bandwidth enforcement is not yet available. Creates requiring an unsupported restriction return 503 NETWORK_POLICY_UNSUPPORTED. Only the organization layer's preview source restrictions are enforced. Host policy updates are not pushed to running sandboxes. The router applies updated organization preview restrictions on each new request, including previews of existing sandboxes, after receiving the new policy version.

Delete an API key's sandbox network policy DELETE

Removes an API key's sandbox network layer using its read version. An API key may delete the layer only when it restricts nothing. A layer outlives its key until it is deleted. Network policy access must be enabled for the organization. Host egress, DNS and bandwidth enforcement is not yet available. Creates requiring an unsupported restriction return 503 NETWORK_POLICY_UNSUPPORTED. Only the organization layer's preview source restrictions are enforced. Host policy updates are not pushed to running sandboxes. The router applies updated organization preview restrictions on each new request, including previews of existing sandboxes, after receiving the new policy version.