Skip to main content

External API reference

Every route is under the API URL shown in the managed application's Outputs. Authentication is a Cloud Connector sign-in token (a bearer token for the Cloud Connector app registration) unless noted as X-API-Key. Callers with a token name the environment with X-CC-Environment: <key>; with an API key, the key names it. See Authentication for how to get each credential.

Triggering loads and runs (X-API-Key or token)​

  • POST /api/connector/enqueue — load one dataset: dataset_id, load_type, optionally source_system_instance.
  • POST /api/connector/enqueue-all — load every enabled dataset of a source system or instance.
  • POST /api/connector/jobs/run — run a job: job_id, optional variable_overrides and start_from. Standard and Enterprise.
  • POST /api/connector/schedules/run — run a schedule: schedule_id, optional start_from. Standard and Enterprise.
  • GET /api/connector/runs/:id/status — poll a triggered run.
  • POST /api/connector/runs/:id/cancel — stop a run.
  • GET /api/connector/queue-status — queued and running counts.
  • GET /api/loadlogs, GET /api/loadlogs/:id/status — load logs.
  • POST /api/connector/actions/run — run an action (token only).

See Triggering runs from outside for the bodies.

The Data API​

  • GET /api/data — the datasets the caller may read, with metadata.
  • GET /api/data/:schema.Dataset — rows, paged. See Reading data through the Data API. Tokens for the Cloud Connector Data app only.

Configuration​

Generic CRUD on every entity: list with search, filter and sort; GET, POST, PUT, PATCH, DELETE by id.

/api/environments, /api/sourcesystems (DELETE ?cascade=true takes the whole tree and the loaded data), /api/sourcesysteminstances, /api/credentials, /api/headers, /api/queryparams, /api/endpoints, /api/datasets (POST /api/datasets/derive creates a nested dataset), /api/variables, /api/globalvariables, /api/exportsystems, /api/action-definitions, /api/jobs, /api/schedules, /api/subscriptions, /api/catalog (on-prem tables), /api/data-access-roles, /api/apikeys, /api/settings.

Run history: /api/logs/runs, /api/logs/steps, /api/logs/loads, /api/loadlogs, /api/scheduledruns, /api/scheduledstepruns, /api/exportsynclogs, /api/webhook-events.

Packages and environments: /api/packages (build and load), /api/templates, /api/environmentsync (compare and sync).

Catalogues: /api/biendpoints, /api/biendpoints/management, /api/sharepoint.

Inbound​

  • POST /api/connector/ingest/webhook/:datasetId/:instanceId (plus /upsert and /delete) — inbound webhook, X-API-Key or ?key=.
  • /api/connector/ingest/* — the Gateway's routes (ping, tables, runtime, catalog, bulk, reconcile, jobs). Agent keys only.

Admin​

  • GET /api/version — build versions and the tier, unauthenticated, for health checks.
  • GET /api/plan — the tier, its limits, and whether AI and Business Plus are available.
  • GET /api/firewall-ips — outbound IPs and the Azure SQL firewall script.
  • GET /api/entra/search, GET /api/entra/objects/:id — directory lookups for the Data access page.