Skip to content
BridgePort
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Start Here
Getting Started
Core Concepts
Installation
Configuration
API Stability
Guides
Users & Roles
Infrastructure
Environments
Servers
Server Bootstrap
Services
Container Images
Registries
Configuration & Secrets
Secrets & Variables
Config Files
Data
Databases
S3 / Spaces Storage
Monitoring
Monitoring Quick Start
Server Monitoring
Service Monitoring
Database Monitoring
Health Checks
Automation & Visualization
Notifications
Service Topology
Deployment Plans
Webhooks
Terraform Provider
Reference
CLI
Agent
MCP Server
Real-Time Events (SSE)
Plugin Authoring
Environment Settings
System Settings
API Reference
Overview
auth
Overview
Authenticate with email + password and receive a JWT
Register the first (admin) user — disabled once any user exists
Introspect the current user, role, environments, and scopes
environments
Overview
List environments visible to the caller
Create an environment (admin only)
Get an environment with denormalized child counts
Delete an environment (admin only)
Compute configuration drift across all deployments in an environment
Check whether an SSH key is configured for an environment
Set the SSH private key and user for an environment (admin only)
Remove the configured SSH key for an environment (admin only)
Retrieve the decrypted SSH private key for CLI access (admin only)
List S3/Spaces buckets available to an environment
Test the S3/Spaces configuration for an environment
Preview diffs for a proposed secret/var substitution
Create a secret/var and substitute the value in config files
servers
Overview
List servers in an environment
Create a server in an environment
Get a server, optionally including its services
Delete a server (admin only)
Update a server
Compute configuration drift for all deployments on a server
Run a health check against a server
Discover containers running on a server
Import servers from Terraform output into an environment
Deploy the monitoring agent to a server
Remove the monitoring agent from a server
Get monitoring agent status for a server
Change a server metrics mode (ssh, agent, or disabled)
Detect the Docker host gateway and SSH reachability for an environment
Register the Docker host machine as a managed server
Get the latest process snapshot reported by the agent for a server
Get bootstrap status for a server (operator+)
Start a bootstrap run on a server (operator+)
Live-add a swap file to a server (operator+)
Prune unused Docker images on a server to reclaim disk space
services
Overview
List services deployed on a server
Create a service template and attach a deployment on a server (legacy)
List service templates in an environment
Create a service template in an environment
Count services per service type within an environment
Get a service template with its deployments
Delete a service template and cascade its deployments
Update a service template
Compute configuration drift for a service across its deployments
Add a deployment of a service template on a server
Remove a service deployment (template is retained)
Update a service deployment
Deploy a service template across all of its deployments
Deploy a single service deployment (supports dry-run)
Get deployment history for a service template
Get a single deployment record
Fetch recent container logs for a deployment
Stream container logs for a deployment over SSE
List available image tags for a service template
Restart the container backing a deployment
Refresh runtime status and health for a deployment
Get audit and deployment history for a service template
Check for a newer image tag for a service template
Resolve a predefined service-type command for the CLI
CI/CD webhook: deploy a service by name or ID
GitHub Actions webhook: deploy on package published events
Webhook: deploy all services for a ContainerImage (respects autoUpdate)
Preview the generated deployment artifacts for a service
Get the compose template for a service
Set a custom compose template for a service
Delete the custom compose template (revert to auto-generated)
Get the artifacts produced by a specific deployment
Download a single deployment artifact
List config files for an environment with sync status
Create a config file in an environment
Get a config file with content and service attachments
Delete a config file
Update a config file
Preview rendered config content with fragments and placeholders resolved (secrets redacted)
Get edit history for a config file
Restore a config file from a history entry
List config files attached to a service
Attach a config file to a service
Detach a config file from a service
Update a service file attachment's target path
Sync a service template's config files across all its deployments
Get config file sync status for all services on a server
Sync all config files for all services on a server
Sync a config file to every (service, server) attachment
Upload a binary asset file (multipart) into an environment
Replace the content of an existing binary asset file (multipart)
List config fragments for an environment
Create a config fragment in an environment
Get a config fragment with its "in use by" references
Delete a config fragment (blocked with 409 when in use)
Update a config fragment (fans out auto-resync on content change)
List container images for an environment
Create a container image in an environment
Get a container image with digests and linked services
Delete a container image (blocked when services depend on it)
Update a container image
Deploy a container image to all linked services
Get tag/deploy history for a container image
List tags from the registry for a container image (unfiltered browse)
Check the registry for updates (triggers a digest sync)
List digests for a container image (paginated)
Get a single digest detail
Link a service to a container image
List services in the same environment that could be re-linked
List a service's dependencies and dependents
Add a dependency to a service
Delete a service dependency
Get the service dependency graph and deployment order for an environment
List services this service can newly depend on
List deployment plans for an environment
Create (and optionally execute) a deployment plan
Get a deployment plan by id
Execute a pending deployment plan (or dry-run preview)
Cancel a pending or running deployment plan
Manually trigger rollback for a deployment plan
Stream deployment plan status updates (SSE)
Get the global object-storage (Spaces) configuration
Create or update the global Spaces configuration (admin only)
Delete the global Spaces configuration (admin only)
Test the configured Spaces credentials and bucket access
List configured or discoverable Spaces buckets
List environments and whether Spaces is enabled for each
Enable or disable Spaces for a specific environment (admin only)
List topology connections for an environment
Create a topology connection between two nodes
Delete a topology connection
Get the saved diagram layout for an environment
Upsert the diagram layout for an environment
List external entities for an environment
Create an external entity in an environment
Delete an external entity (and its dangling connections)
Update an external entity
List server clusters for an environment
Create a server cluster in an environment
Delete a server cluster (servers are detached, not deleted)
Update a server cluster
Export the environment topology as a Mermaid diagram
Execute (or replay) a transactional batch of config-file syncs
Fetch a persisted sync batch and its operations
secrets
Overview
List secrets (without values) with usage information
Create a secret in an environment
Reveal the decrypted value of a secret (admin only)
Delete a secret
Update a secret value or metadata
List vars with usage information
Create a var in an environment (operator+)
Delete a var (operator+)
Update a var value or metadata (operator+)
admin
Overview
List audit logs with optional filters and pagination
List registry connections for an environment
Create a registry connection in an environment
Get a registry connection
Delete a registry connection (blocked when images are attached)
Update a registry connection
Test connectivity for a registry connection
List repositories in a registry
List tags for a repository in a registry
List services using this registry
Force an update check for all services linked to this registry
List all users
Create a user
List users active within the configured window
Get a single user (admin or self)
Delete a user (cannot delete self)
Update a user (admin updates anyone; users update their own name)
Change a user's password (admin or self)
List all notification types (admin only)
Update notification type settings (admin only)
Get the SMTP email configuration
Save the SMTP email configuration
Test SMTP connection or send a test email
List all outgoing webhooks
Create an outgoing webhook
Get a single outgoing webhook
Update an outgoing webhook
Delete an outgoing webhook
Send a test event to a webhook
List all Slack channels
Create a Slack channel
Get a single Slack channel
Update a Slack channel
Delete a Slack channel
Send a test message to a Slack channel
List all Slack notification routings
Update Slack routings for a notification type
Delete a Slack routing for a type + channel
Get Sentry configuration status
Send a test event to backend Sentry
Get MCP server status and exposed tool/resource inventory
Get the result of the last plugin sync
List all service types with their commands
Create a service type (admin only)
Get a single service type
Delete a service type (admin only)
Update a service type (admin only)
Reset a service type to its plugin defaults (admin only)
Export a service type as a plugin JSON file (admin only)
Add a command to a service type (admin only)
Delete a service type command (admin only)
Update a service type command (admin only)
Reorder the commands of a service type (admin only)
List all database types with their commands
Create a database type (admin only)
Get a single database type
Delete a database type (admin only)
Update a database type (admin only)
Reset a database type to its plugin defaults (admin only)
Export a database type as a plugin JSON file (admin only)
Add a command to a database type (admin only)
Delete a database type command (admin only)
Update a database type command (admin only)
Get current system settings
Update system settings (admin only)
Reset system settings to defaults (admin only)
Get the environment settings registry (field definitions)
Get settings for a specific environment settings module
Update settings for a specific environment settings module
Reset an environment settings module to its defaults
Get the environment's Slack notification channel override and options
Set the environment's Slack notification channel override
Send a test Slack message via the environment's resolved channel
List service accounts
Create a service account
Get a service account
Delete a service account (cascades to its tokens)
Update a service account
List API tokens (optionally filtered by owner)
Create an API token (full token returned once)
Revoke an API token
monitoring
Overview
Get metrics for a server
Get metrics for a service
Get the environment metrics summary
Manually trigger metrics collection for a server
Agent metrics ingest endpoint (agent-token authenticated)
Get agent configuration (agent-token authenticated)
Regenerate the agent token and redeploy the agent
List databases for an environment
Create a database in an environment
Get a database by id
Delete a database (must have no backups)
Update a database
List backups for a database
Trigger a backup for a database
Get backup details
Delete a backup
Download a backup (file stream or presigned URL)
Get the backup schedule for a database
Set the backup schedule for a database
Delete the backup schedule for a database
Get the effective backup retention policy for a database
Set or replace the backup retention policy for a database
Revert a database to the global default retention policy
Preview the keep/prune outcome of a backup retention policy
Rotate a database's backups now using its current policy
Pin or unpin a backup (pinned backups are never pruned by rotation)
Get the backup summary for all databases in an environment
Get the monitoring summary for all databases in an environment
Get metrics history for a specific database
Test a database connection (lightweight ping)
Update monitoring configuration for a database
List health-check logs with filtering and pagination
Trigger immediate health checks for an environment
Get columnar server metrics history for charts
Get columnar service metrics history for charts
Test the SSH connection for a single server
Test SSH connections for all servers in an environment
Get monitoring overview stats for an environment
Get current health status of servers, services, and databases
Get agent/SSH status for all servers in an environment
Get agent events for a server
Subscribe to the server-sent events stream
Operations
/api/environments/{envId}/databases/metrics/history
List notifications for the current user
Get the unread notification count for the current user
Mark a notification as read
Mark all notifications as read for the current user
Get notification preferences for the current user
Update the current user's preference for a notification type
/api/environments/{envId}/config-scan
system
List available CLI binary downloads
Download a CLI binary for an OS/arch
webhooks
List env-scoped webhook subscriptions
Create an env-scoped webhook subscription
Get a single env-scoped webhook subscription
Delete an env-scoped webhook subscription
List delivery history for a webhook subscription
Operations
Upgrades
Security & Hardening
Backup & Restore
Troubleshooting
Architecture Patterns
Changelog
GitHub
Select theme
Dark
Light
Auto
Overview
monitoring
Section titled “monitoring”
Health logs, metrics, and observability
Operations
Section titled “Operations”
GET
/api/servers/{id}/metrics
GET
/api/services/{id}/metrics
GET
/api/environments/{envId}/metrics/summary
POST
/api/servers/{id}/collect-metrics
POST
/api/metrics/ingest
GET
/api/agent/config
POST
/api/servers/{id}/regenerate-agent-token
GET
/api/environments/{envId}/databases
POST
/api/environments/{envId}/databases
GET
/api/databases/{id}
DELETE
/api/databases/{id}
PATCH
/api/databases/{id}
GET
/api/databases/{id}/backups
POST
/api/databases/{id}/backups
GET
/api/backups/{id}
DELETE
/api/backups/{id}
GET
/api/backups/{id}/download
GET
/api/databases/{id}/schedule
PUT
/api/databases/{id}/schedule
DELETE
/api/databases/{id}/schedule
GET
/api/databases/{id}/backup-policy
PUT
/api/databases/{id}/backup-policy
DELETE
/api/databases/{id}/backup-policy
POST
/api/databases/{id}/backup-policy/preview
POST
/api/databases/{id}/rotate
PUT
/api/databases/{id}/backups/{backupId}/pin
GET
/api/environments/{envId}/databases/backup-summary
GET
/api/environments/{envId}/databases/monitoring-summary
GET
/api/environments/{envId}/databases/{id}/metrics
POST
/api/environments/{envId}/databases/{id}/test-connection
PATCH
/api/environments/{envId}/databases/{id}/monitoring
GET
/api/environments/{envId}/health-logs
POST
/api/environments/{envId}/health-checks/run
GET
/api/environments/{envId}/metrics/history
GET
/api/environments/{envId}/services/metrics/history
POST
/api/servers/{id}/test-ssh
POST
/api/environments/{envId}/test-all-ssh
GET
/api/environments/{envId}/monitoring/overview
GET
/api/environments/{envId}/health-status
GET
/api/environments/{envId}/agents
GET
/api/servers/{id}/agent-events
GET
/api/events
