Skip to content
Docs
GitHub

Get the organization's outbound allowlist extension

Preview

Get the organization’s outbound allowlist extension: whether a platform administrator granted it, its host patterns, and the deployment’s egress policy mode.

Public APIEverruns Cloud and self-hosted Platform

GET/v1/orgs/{org}/egress-allowlist

See authentication for credentials and permissions.

org
required
string

Prefixed public identifier

Responses

200Success

Success

Media typeapplication/json

An organization’s egress allowlist extension.

object
can_edit
required

Whether the caller may edit the patterns (an organization admin; the edit also needs granted).

boolean
can_grant
required

Whether the caller may grant or revoke (a platform administrator).

boolean
granted
required

Whether a platform administrator allowed this organization to extend the deployment’s outbound allowlist. Patterns are enforced only while this is true.

boolean
max_patterns
required

Most patterns one organization may add.

integer
mode
required

The deployment’s egress policy: open, curated-writes, or curated-all. Extensions only matter in a curated mode.

string
open
required

Whether a platform administrator granted this organization open egress: its agents reach any public host the deny list allows, for reads and writes, whatever the deployment’s curated policy.

boolean
patterns
required

Host patterns this organization adds to the allowlist: example.com, *.example.com, or an https://example.com/path/ prefix.

Array<string>

Example

{
"mode": "curated-writes"
}
404Organization not found

Organization not found