/

/Temps

Changes Docs Sign in

Docs
History
Schema

Filter operations

AdminGate2

Agents56

AI Applications29

AI Chat43

AI Gateway14

AI Gateway Admin12

AI Gateway Pricing1

AI Gateway Usage7

AI Provider Status3

Alarms12

Alerts6

Analytics43

Analytics Ingest Keys5

API Keys9

Audit Logs2

Authentication29

Autofixer7

Backups35

Blob6

Blob Management4

Cloud8

Containers8

Crons3

Custom Domains8

Dashboards5

Deployment Tokens6

Deployments25

DNS1

DNS Providers14

DNS Records4

Domains19

Email Domains12

Email Providers9

Email Tracking7

Email Validation1

Emails5

Environments2

error-alert-rules5

error-tracking10

Events13

External Images7

External Services49

get/external-servicesGet all external services
post/external-servicesCreate new external service
get/external-services/available-containersList available Docker containers that can be imported as services
get/external-services/by-slug/{slug}Get external service details by slug
get/external-services/health-status-batchCurrent health status for many services at once
post/external-services/importImport an existing Docker container as a managed external service
get/external-services/projects/{project_id}List services linked to a project
get/external-services/projects/{project_id}/environmentGet all environment variables for all services linked to a project
get/external-services/providers/metadataGet provider metadata (display names, icons, descriptions)
get/external-services/providers/metadata/{service_type}Get metadata for a specific provider
get/external-services/typesGet available service types
get/external-services/types/{service_type}/parametersGet parameter schema for a specific service type
get/external-services/{id}Get external service details
put/external-services/{id}Update external service
delete/external-services/{id}Delete external service
get/external-services/{id}/cluster-healthPer-member health for a Postgres HA cluster.
post/external-services/{id}/continuous-archive-sourceRepoint a service's continuous archive source
get/external-services/{id}/data-imports
post/external-services/{id}/data-imports
get/external-services/{id}/data-imports/availability
get/external-services/{id}/data-imports/{run_id}
post/external-services/{id}/data-imports/{run_id}/cancel
get/external-services/{id}/environmentReveal a service's basic environment variables in plaintext, before it is linked to any project. Used by the new-project wizard to fill a detected variable (e.g. `DATABASE_URL`) from a service the user just picked or created — every successful reveal is recorded, matching the audited single-variable reveal used once a service is project-linked.
post/external-services/{id}/health-checkRun a health check for one service right now
get/external-services/{id}/health-statusPersisted health status for an external service
post/external-services/{id}/membersBegin adding a single new member to a running cluster.
get/external-services/{id}/members/{member_id}Get a single cluster member's current state.
delete/external-services/{id}/members/{member_id}Remove a single member from a running cluster.
post/external-services/{id}/members/{member_id}/promotePromote a replica to primary by triggering a pg_auto_failover failover. The monitor demotes the current primary and the chosen replica transitions to primary; the role reconciler then refreshes the role-aliased VIPs (≤30s).
get/external-services/{id}/parameters/{param_name}Reveal one sensitive service parameter. Service detail responses never contain plaintext values; every successful reveal is recorded separately.
get/external-services/{id}/preview-environment-maskedGet environment variables preview with masked sensitive values
get/external-services/{id}/preview-environment-namesGet environment variable names preview (safe - no sensitive values)
get/external-services/{id}/projectsList projects linked to service
post/external-services/{id}/projectsLink service to project
delete/external-services/{id}/projects/{project_id}Unlink service from project
get/external-services/{id}/projects/{project_id}/environmentGet all environment variables for a service-project pair
get/external-services/{id}/projects/{project_id}/environment/{var_name}Get specific environment variable for a service-project pair
post/external-services/{id}/projects/{project_id}/environments/{environment_id}/runtime-credentialsIssue live connection credentials for a service in an environment
patch/external-services/{id}/resourcesUpdate a service's resource limits (memory, CPU caps).
post/external-services/{id}/retryRetry a failed cluster service initialization.
get/external-services/{id}/runtimeInspect a service's container(s): status, restart count, OOM-killed flag, exit code, and the cgroup limits actually applied.
post/external-services/{id}/startStart an external service
get/external-services/{id}/statsSample current CPU/memory usage from each of a service's containers. One-shot sample, no streaming. Cheap to call (single Docker round-trip per member) so the UI can poll on a 5–10s interval.
post/external-services/{id}/stopStop an external service
post/external-services/{id}/upgradeUpgrade external service to new Docker image with data migration This endpoint uses service-specific upgrade procedures (e.g., pg_upgrade for PostgreSQL)
get/external-services/{id}/wal-healthPostgres WAL & archive health snapshot
post/external-services/{service_id}/pg-stat-statements/enableEnable `pg_stat_statements` on a standalone Postgres service.
post/external-services/{service_id}/pg-stat-statements/resetReset all statistics accumulated by `pg_stat_statements` for a Postgres service. This affects every user, database, and normalized query tracked by the target Postgres instance and cannot be undone.
get/external-services/{service_id}/pg-stat-statements/slow-queries

External Services - Query11

Feature Flags9

Files1

Funnels7

GenAI2

geo2

Git Provider Connections3

Git Providers35

HTTP Checks12

Imports5

Insights1

Internal DNS2

IP Access Control6

KV Management4

KV Store7

Load Balancer5

Logs11

Metrics17

Nodes27

Notification Preferences4

Notification Providers15

Notification Routes7

Observability2

Operations1

OTel15

OTel Facets4

OTel Ingest6

Performance6

Platform6

Postgres Upgrades7

Presets2

Preview Gateway6

Projects46

Proxy Logs14

Public Repositories6

Repositories6

Restore6

Revenue16

Sandboxes39

Secrets7

sentry-compat6

sentry-ingestor3

Settings16

Snapshots5

source-maps8

Static Bundles4

Status Page32

Teams13

Telemetry2

Telemetry Logs1

Telemetry Metrics4

Templates3

Traces8

Traefik Discovery6

Traffic Delivery11

Users13

Visitor Activity5

Vulnerability Scans8

Webhook Deliveries3

Webhooks6

Workflows1

get/projects/{project_id}/dsnsList all DSNs for a project
post/projects/{project_id}/dsnsCreate a new DSN for a project
post/projects/{project_id}/dsns/get-or-createGet or create DSN for a project/environment/deployment combination
post/projects/{project_id}/dsns/{dsn_id}/regenerateRegenerate DSN keys (rotate keys)
post/projects/{project_id}/dsns/{dsn_id}/revokeRevoke (deactivate) a DSN

External Services

Changes to Start an external service

post/external-services/{id}/start

Oct 9, 2026c2e6bffeca6c Revision changes
- info
  added the optional property to the response with the status