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

GET

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

const url = 'https://app.everruns.com/api/v1/orgs/example/egress-allowlist';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.everruns.com/api/v1/orgs/example/egress-allowlist

Parameters

Path Parameters

org

required

string

Prefixed public identifier

Responses

200

Success

application/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

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"
}

404

Organization not found