Customer-managed egress and remotes API (EAP)

Once the manifest of an app has been configured, the app can interact with customer‑managed egress and remotes using the async Forge functions in the permissions module in @forge/bridge.

Set egress

When permissions.egress.set is called, an admin will see a confirmation modal describing the egress that will be added. If they approve, the group is saved and the Promise resolves. If they reject, the Promise rejects. This requires the user to be an administrator. This promise can be caught in the Forge app code and relevant errors can be shown to the user and handled as appropriate.

When this is called an admin will see a confirmation modal describing the egress that will be added. If they approve, the group is saved and the Promise resolves. If they reject, the Promise rejects. This requires the user to be an administrator otherwise the Promise will reject. This Promise can be caught in the Forge app code and relevant errors can be shown to the user and handled as appropriate.

Request

Responses

Example

1
2
import { permissions } from "@forge/bridge";
import { EgressType } from "@forge/egress";

async function configureEgress() {
  await permissions.egress.set({
    egresses: [
      {
        key: "example-egress",
        description: "Access to example.com",
        configured: [
          {
            domain: "https://api.example.com",
            type: [EgressType.Image],
          },
        ],
      },
    ],
  });
}

Get egress

When permissions.egress.get is called, any previously configured egress groups will be returned. This call does not require a user to be an administrator.

Request

Responses

Example

1
2
import { permissions } from "@forge/bridge";

async function getEgress() {
  const getAllEgressGroups = await permissions.egress.get({});
  const getSomeEgressGroups = await permissions.egress.get({
    keys: ["my-egress-group-1", "my-egress-group-2"],
  });
}

Delete domain from egress group

Use permissions.egress.deleteDomain to delete a single domain from a previously defined egress group. This is useful when you want to keep the group but remove one domain/type entry. This requires the user to be an administrator.

Request

Response

Example

1
2
import { permissions } from "@forge/bridge";

async function deleteEgress() {
  await permissions.egress.deleteDomain({
    key: "my-egress-group",
    domain: "http://www.example.com",
    type: "FRAMES",
  });
}

Delete group

Use permissions.egress.deleteGroup to delete an entire egress group and all of its defined domains. This requires the user to be an administrator.

Request

Response

Example

1
2
import { permissions } from "@forge/bridge";

async function deleteEgress() {
  await permissions.egress.deleteGroup({
    key: "my-egress-group",
  });
}

Set remote endpoint

Use permissions.remote.set to set or update the endpoint of a customer-managed remote. This requires the user to be an administrator.

Request

Response

Example

1
2
import { permissions } from "@forge/bridge";

async function setRemote() {
  await permissions.remote.set({
    remotes: [
      {
        key: "my-remote",
        configured: {
          endpoint: "https://example.com",
        },
      },
    ],
  });
}

Get remote endpoint

Use permissions.remote.get to get previously configured remotes for an installation. You can fetch specific remotes or all remotes. This does not require the user to be an administrator.

Request

Response

Example

1
2
import { permissions } from "@forge/bridge";

async function getRemotes() {
  const getAllRemotes = await permissions.remote.get({});
  const getSomeRemotes = await permissions.remote.get({
    keys: ["my-remote", "my-remote-2"],
  });
}