Xeonr Developer Docs
API SpecificationEgress

Get Egress Policy

POST
/containers.api.v1.EgressPolicyService/GetEgressPolicy

Returns one named egress policy. NotFound for an unknown id.

Access: namespace VIEWER or above (read)

Authorization

BearerAuth
AuthorizationBearer <token>

A namespace-scoped API key (cpk_…) for machines, or a Xeonr Auth OIDC token for humans. The key's namespace and role are pinned server-side.

In: header

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

egressPolicyId?string
Length1 <= length <= 64
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.EgressPolicyService/GetEgressPolicy" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "policy": {
    "egressPolicyId": "string",
    "namespace": "string",
    "name": "string",
    "policy": {
      "mode": "MODE_UNSPECIFIED",
      "allow": [
        {
          "hostPattern": "string",
          "ports": [
            0
          ],
          "mode": "RULE_MODE_UNSPECIFIED",
          "pathPrefixes": [
            "string"
          ],
          "methods": [
            "string"
          ],
          "maxResponseBytes": "string",
          "allowPlainHttp": true
        }
      ],
      "presets": [
        "string"
      ],
      "allowPlainHttp": true
    },
    "updatedAtUnix": "string"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Delete Egress Policy POST

Deletes a named egress policy. **Access:** namespace OPERATOR or above (write)

List Egress Events POST

Lists egress proxy decisions (allowed and denied) from the audit trail, newest first, optionally narrowed to one job/sandbox (principal_id) and to events at or after since_unix (0 means everything retained). page_size defaults to 100 and is clamped to 1000. Unimplemented when the event feed is not enabled. **Access:** namespace VIEWER or above (read). `namespace` is required unless the caller is a platform admin, for whom empty covers every namespace.