Custom API

A custom integration lets Nebula call an HTTP API that is not in the catalog, such as an internal asset inventory.

Requirements

• An HTTPS API with API-key or basic authentication.
• The integrations:manage member scope to connect, and integrations:use to call it.

Connect

In Settings, Integrations, add a custom integration and provide:

Field	Notes
Name and description	What Nebula should know the API is for.
Base URL	The API’s HTTPS origin. The host is checked when you connect and on every request, so private and loopback addresses are refused.
Authentication	API key (with its header or query parameter) or basic authentication.
Documentation URL	An HTTPS link to the API’s docs.
Example endpoints	Up to 8 paths that show Nebula what to call.

The proxy contract

Nebula calls your API through BreachLine’s integration proxy. It:

• prefixes every request with your fixed base URL, so a request cannot be pointed elsewhere;
• forwards only these request headers: Accept, Content-Type, If-Match, If-None-Match, Idempotency-Key, and the version headers Notion-Version, X-GitHub-Api-Version and Stripe-Version;
• never follows redirects;
• redacts your credential if the response echoes it;
• caps responses at 2 MiB and times out after 30 seconds.

Tip

Create a dedicated, read-only credential for Nebula, so you can revoke it independently and limit what it can change.