Skip to content
Good Gateway
Search
Ctrl
K
Cancel
Product
API Reference
GitHub
Select theme
Dark
Light
Auto
Customer stories
Wiolett Industries
Remedy Trade
Just Working
DFK Algotrade
Square Labs
Start here
Good Gateway documentation
Why Gateway
Product tour
Adoption pilot
Requirements and planning
Install Gateway
Manual installation
Initial setup
Add your first node
Publish your first route
Concepts
Architecture
Infrastructure ownership and IaC
Resource model and ownership
Permissions and scopes
Secure Links
Lifecycle and safety model
Plugin system
End-to-end journeys
Publish an application end to end
Git to production
Connect an application to a private database
Publish a static site with Pages
AI and inference
AI agent skills
AI Workspace
Gateway Inference
Ingress
Ingress overview
Domains, Routes, and TLS
Access lists and maintenance mode
Secure upstreams
Ingress troubleshooting
Nodes and Relay
Nodes and daemons
Node roles and installation
Node updates and offline behavior
Relay and Relay Pool
Docker
Docker overview
Containers
Blue/green Deployments
Compose Projects
Workload Availability (HA)
Git sources and Build Workers
Migrations and container archives
Images, volumes, and networks
Registries and image trust
Databases
Databases overview
Managed databases
Application database bindings
Database operations
Pages
Pages overview
Pages Git deployments
Certificates and PKI
SSL certificates
Internal PKI
Observe and notify
Observability overview
Notifications and status pages
Structured logging and SIEM
Identity and access
Authentication, users, and groups
Scopes, API tokens, OAuth, and MCP
Scope reference
Integrations
Integrations
Hosting providers
Git hosting
SSH connections
Cloudflare
DNS, email, and webhooks
Automation
REST API and MCP
Operations and security
Production readiness checklist
Availability, compatibility, and limits
Updates, backups, and restore
Incident runbook
Security model
Hardening checklist
Reference
Capability index
Plans and entitlements
Ports and network paths
Tasks, events, and audit
Glossary
API Reference
Overview
Authentication
Overview
Initiate OIDC login
OIDC callback
Get CSRF token for the current session
Stop impersonating and restore the original browser session
Log out the current browser session
Get the current authenticated user
Get current user preferences
Update current user preferences
Update or remove the current user's custom avatar
Remove the current user's custom avatar
Get the current local account MFA status
Start TOTP enrollment for the current local account
Reset the current local account TOTP factor and recovery codes
Confirm TOTP enrollment and return one-time recovery codes
Regenerate recovery codes after verifying the active TOTP factor
List active browser sessions for the current user
Revoke another active browser session
Revoke every active browser session except the current one
Certificate Authorities
Overview
List certificate authorities
Create a root certificate authority
Get certificate authority details
Update certificate authority settings
Delete a certificate authority
Create an intermediate certificate authority
Revoke a certificate authority
Export a certificate authority private key
Create an OCSP responder certificate
Certificates
Overview
List issued certificates
Issue a certificate with server-side key generation
Get certificate details
Issue a certificate from a CSR
Revoke a certificate
Export a certificate, PEM chain, private key, or PEM bundle
Download certificate chain
Templates
Overview
List certificate templates
Create a certificate template
Get certificate template details
Delete a certificate template
Update a certificate template
PKI
Overview
Download a certificate revocation list
Submit an OCSP request
Submit a base64-encoded OCSP request
Download a CA certificate
Audit
Overview
List SIEM audit export destinations
Create a SIEM audit export destination
Get a SIEM audit export destination
Update a SIEM audit export destination
Soft-delete a SIEM destination and discard outstanding deliveries
Send a synthetic SIEM test event
List SIEM audit export delivery records
Get SIEM delivery details
Requeue a failed SIEM delivery
List users present in audit log entries
List audit log entries
Prepare a filtered audit log export
Alerts
Overview
List alerts
Dismiss an alert
Tokens
Overview
List API tokens
Create an API token
Revoke an API token
Update an API token
Admin
Overview
List permission groups
Create a permission group
Get permission group details
Update a permission group
Delete a permission group
List users
Create a user
List deleted users
Get Gateway settings
Update Gateway settings
Change a user's primary sign-in method
Rename a local user's account
Reset a user's avatar
Email a password setup or reset link to a local password user
Reset a user's Gateway MFA factors
Update a user permission group
Replace a user's additional permissions
Block or unblock a user
Delete a user
Restore a deleted user in blocked state
List a user's active browser sessions
Revoke all of a user's active browser sessions
Start a protected browser impersonation session
Revoke a user's active browser session
Nodes
Overview
List nodes
Create node enrollment
List node folders
Create a node folder
Reorder node folders
Move nodes to a folder
Reorder nodes within a folder
Rename a node folder
Delete a node folder
Move a node folder
Resolve node details by slug
Get node details
Delete a node
Update node display metadata
Get node health history
List node files
Delete node file or directory
Read node file
Write node file
Create or overwrite node file
Initialize node file upload
Upload node file chunk
Complete node file upload
Abort node file upload
Create node directory
Move node file or directory
Lock or unlock new service creation on a node
Read nginx global config from a node
Update nginx global config on a node
Test nginx config on a node
Stream node monitoring snapshots over SSE
Stream daemon logs for a node
Stream nginx access and error logs for a node
Routes
Overview
List ingress routes
Create an ingress route
Resolve ingress route by slug
Get ingress route details
Update an ingress route
Delete an ingress route
Get ingress route health history
List managed Additional Routes for an ingress route
Create a managed Additional Route
Get a managed Additional Route
Update a managed Additional Route
Delete a managed Additional Route
Retry a failed managed Additional Route
Enable or disable an ingress route
Enter or exit maintenance mode for an ingress route
Retry TLS deployment for an ingress route
Get rendered nginx config for an ingress route
Validate advanced nginx config
Route Folders
Overview
List route folders
Create a route folder
List grouped ingress routes and folders
Move routes into a folder
Reorder route folders
Reorder routes
Update a route folder
Delete a route folder
Move a route folder
Clone a route folder
Nginx Templates
Overview
List nginx templates
Create an nginx template
Get an nginx template
Update an nginx template
Delete an nginx template
Clone an nginx template
Preview rendered nginx template config
Test nginx template config
Docker Containers
Overview
List containers
Create a container
List visible container users for each managed GPU
Inspect a container by exact name
Inspect a container
Remove a container
Start a container
Stop a container
Restart a container
Kill a container
Rename a container
Duplicate a container
Stream a Gateway container archive
Plan target resource mappings for a Gateway container archive
Import a streamed Gateway container archive
Pull and redeploy a container image
Update runtime settings without recreation
Recreate a container with new settings
Get container logs
Get container stats
Get container stats history
Get container process list
Get container environment
Update container environment
Docker Deployments
Overview
List blue/green deployments
Create a blue/green deployment
Get a deployment by exact name
Get a deployment
Update a deployment
Delete a deployment
Start a deployment
Stop a deployment
Restart a deployment
Kill a deployment
Deploy a new inactive slot
Switch deployment slot
Rollback a deployment
Stop a deployment slot
Get deployment webhook config
Configure deployment webhook
Delete deployment webhook
Regenerate deployment webhook token
Get deployment image cleanup settings
Configure deployment image cleanup
Docker Images
Overview
List images
Pull an image asynchronously
Pull an image synchronously
Remove an image
Prune unused images
Docker Volumes
Overview
List managed volume names available for container mounts
List volumes
Create a volume
Inspect a volume
Remove a volume
List volume files
Delete a volume file or directory
Read a volume file
Write a volume file
Create a volume file
Initialize a chunked volume file upload
Upload one chunk for a volume file upload
Complete a chunked volume file upload
Abort a chunked volume file upload
Create a volume directory
Move a volume file or directory
Export a volume
Rename a volume
Update volume labels
Get cached volume metrics
Grow a managed disk-image volume
Adopt an eligible legacy local volume without copying data
Docker Networks
Overview
List networks
Create a network
Remove a network
Connect a container to a network
Disconnect a container from a network
Docker Registries
Overview
Get the Gateway internal registry state
Update Business+ external access settings for the Gateway internal registry
Run retention and garbage collection for the Gateway internal registry
Resume an interrupted internal registry maintenance run
List registries
Create a registry
Update a registry
Delete a registry
Test registry credentials
Test a saved registry
Docker Folders
Overview
List Docker folders
Create a Docker folder
Reorder Docker folders
Reorder resources inside Docker folders
Reorder containers inside Docker folders
Update a Docker folder
Delete a Docker folder
Move containers into a Docker folder
Move Docker resources into a folder
Get Docker resource folder placements
Docker Health Checks
Overview
Get a container health check
Configure a container health check
Test a container health check
Get a deployment health check
Configure a deployment health check
Test a deployment health check
Docker Migrations
Overview
Preflight a Docker node migration
List visible Docker migrations
Start a durable Docker node migration
Get a Docker migration
Cancel and roll back a migration before cutover
Retry source cleanup after a successful cutover
Docker Secrets
Overview
List deployment secrets
Create a deployment secret
Update a deployment secret
Delete a deployment secret
List container secrets
Create a container secret
Update a container secret
Delete a container secret
Docker Files
Overview
List container directory
Delete a container file or directory
Read a container file
Write a container file
Create a container file
Initialize a chunked container file upload
Upload one chunk for a container file upload
Complete a chunked container file upload
Abort a chunked container file upload
Create a container directory
Move a container file or directory
Docker Tasks
Overview
List background tasks
Get a background task
Force-cancel an active background task
Docker Webhooks
Overview
Get container webhook config
Configure container webhook
Delete container webhook
Regenerate container webhook token
Trigger a Docker webhook
SSL Certificates
Overview
List SSL certificate folders
Create an SSL certificate folder
Reorder SSL certificate folders
Move SSL certificates to a folder
Reorder SSL certificates within a folder
Rename an SSL certificate folder
Delete an SSL certificate folder
Move an SSL certificate folder
List SSL certificates
Get SSL certificate details
Delete an SSL certificate
Request an ACME certificate
Upload an SSL certificate
Link an internal CA certificate for proxy use
Renew an SSL certificate
Update SSL certificate auto-renewal settings
Complete DNS-01 certificate verification
Cancel a pending ACME certificate request
Retry SSL certificate deployment to ingress nodes used by active TLS routes
Domains
Overview
List domain folders
Create a domain folder
Reorder domain folders
Move domains to a folder
Reorder domains within a folder
Rename a domain folder
Delete a domain folder
Move a domain folder
List domains
Create a domain
Search domains for autocomplete
List eligible Nginx ingress nodes for domains
Preview DNS readiness for a domain
Get domain details
Update a domain
Delete a domain
Run a DNS check for a domain
Resolve a Cloudflare migration conflict
Preview a domain ingress migration
Move a domain and its routes to another nginx ingress node
Issue an ACME certificate for a domain
Access Lists
Overview
List access lists
Create an access list
Get access list details
Update an access list
Delete an access list
Databases
Overview
List curated managed database versions
List managed database instances
Deploy a managed database instance
Get managed database instance details
Delete a managed database instance
Update managed database configuration
Retry failed managed database provisioning
Restart a managed database container
Pause a managed database container
Unpause a managed database container
Reveal managed database direct-access credentials
Rotate managed database direct-access credentials
Rotate a managed database direct-TLS certificate
List managed database bindings
Create a managed database binding
Delete a managed database binding
Get managed database binding Relay runtime
Reveal managed database binding credentials
List database folders
Create a database folder
Reorder database folders
Move database connections to a folder
Reorder database connections within a folder
Rename a database folder
Delete a database folder
Move a database folder
List database connections
Create a database connection
Resolve database connection by slug
Get database connection details
Delete a database connection
Update a database connection
Get database connection health history
Test a saved database connection
Reveal stored database credentials
Stream database monitoring snapshots
List SQL database namespaces
List SQL tables and views
Get SQL table metadata
Browse SQL table rows
Insert a SQL table row
Delete one uniquely identified SQL table row
Update one uniquely identified SQL table row
Execute a provider-specific SQL statement
List extensions built into a managed PostgreSQL image
Enable a built-in managed PostgreSQL extension
Disable a managed PostgreSQL extension
List PostgreSQL schemas
List PostgreSQL tables
Get PostgreSQL table metadata
Browse PostgreSQL table rows
Insert a PostgreSQL row
Delete a PostgreSQL row
Update a PostgreSQL row
Add a PostgreSQL column
Delete a PostgreSQL column
Update a PostgreSQL column data type
Execute a PostgreSQL SQL statement
Scan Redis keys
Get a Redis key
Set a Redis key
Delete a Redis key
Set Redis key expiration
Execute a Redis command
Status Page
Overview
Get public status page data
Get status page settings
Update status page settings
List status page proxy templates
List exposed status page services
Expose a service on the status page
Reorder exposed status page services
Update an exposed status page service
Remove an exposed status page service
List status page incidents
Create a manual status page incident
Update a status page incident
Delete a status page incident
Resolve a status page incident
Promote an automatic incident to manual
Create a status page incident update
Get status page preview data
Logging
Overview
Ingest one log event
Ingest a batch of log events
Get ClickHouse logging storage health
List logging environments
Create a logging environment
Resolve a logging environment by slug
Get a logging environment
Update a logging environment
Delete a logging environment
List logging schemas
Create a logging schema
Resolve a logging schema by slug
Get a logging schema
Update a logging schema
Delete a logging schema
List logging tokens
Create a logging token
Delete a logging token
Search logs
Get log facets
Get log metadata
AI
Overview
Get AI feature status
Get AI configuration
Update AI configuration
List AI tool definitions
Inference
Overview
Get current-user Gateway quota percentages and raw token totals for inference clients
Read the managed inference core lifecycle status
Install the managed inference core on this Gateway host
Update the managed inference core with automatic rollback
Repair a degraded or failed inference core
Check the release channel for a newer core and record the result
List inference tokens for the current user
Create a copy-once inference token
Revoke an inference token
System
Overview
Get gateway version and update status
Get gateway runtime configuration
Check for gateway updates
Trigger gateway self-update
Trigger relay self-update
Get release notes for a version
Get release notes for available updates
List daemon update status
Check for daemon updates
Trigger daemon update for a node
License
Overview
Get license status
Activate a license key
Check license status now
Clear the active license key
Housekeeping
Overview
Get housekeeping config
Update housekeeping config
Get housekeeping stats
Run housekeeping now
List housekeeping run history
Monitoring
Overview
Get dashboard monitoring stats
Get dashboard bootstrap snapshot
Get proxy health status overview
Stream ingress route logs
Notifications
Overview
List notification alert categories
List notification alert rules
Create a notification alert rule
Get notification alert rule details
Update a notification alert rule
Delete a notification alert rule
List notification webhook template presets
List notification webhooks
Create a notification webhook
Get notification webhook details
Update a notification webhook
Delete a notification webhook
Render a webhook template preview
Send a test notification webhook delivery
List notification deliveries
Get notification delivery stats
Get notification delivery details
Inference Providers
List supported inference provider connectors
List inference provider connections without secrets
Connect an API-key or local inference provider
Start a provider OAuth or device flow
Read an OAuth session owned by the current administrator
Complete or poll a provider OAuth session
Cancel a pending provider OAuth session
Synchronize models, quota, and health for a provider connection
Disconnect a provider and destroy its stored credential
Update a provider connection
Set implicit routing strategy for a provider
Inference Models
List published inference models with sources and admin metadata
Persist the display and client manifest order of inference models
Create a logical model, provider bindings, pricing, and access atomically
Replace model metadata, provider bindings, pricing, and access atomically
Delete a logical inference model
Suggest matching accounts from the selected provider model
Inference Usage
Get only user-visible usage percentages and recovery times
Get 30-day inference usage totals for the current user
Get raw system usage and upstream quota for administrators
Get raw per-user usage and limits for administrators
List available users and models for inference activity filters
List metadata-only inference activity for administrators
Inference Limits
List system default and per-user limit policies
List users and effective policies without system usage data
Set the system default inference limit policy
Set a per-user inference limit override
Remove a per-user inference limit override
Reset all inference usage limits for a user
Admin Folders
List permission group folders
Create a permission group folder
Reorder permission group folders
Move permission groups to a folder
Reorder permission groups
Update a permission group folder
Delete a permission group folder
Move a permission group folder
List user folders
Create a user folder
Reorder user folders
Move users to a folder
Reorder users
Update a user folder
Delete a user folder
Move a user folder
Docker Nodes
Resolve compact Docker node route context by slug
Check runsc compatibility and health
Install and verify runsc on a Docker node
Docker Image Cleanup
Get container image cleanup settings
Configure container image cleanup
Docker Compose
List external and managed Compose projects
Get a Compose project
Delete a stopped managed Compose project record
Validate a single-file image-only Compose project
Create a managed Compose project and its first immutable revision
Prepare an external Compose project for adoption
List immutable Compose revisions
Create an immutable Compose revision
Get an immutable Compose revision
Delete an inactive immutable Compose revision
List Compose lifecycle operations
Start a managed Compose lifecycle operation
List masked Compose secret bindings
Create or replace a Compose secret binding
Update a Compose secret binding
Delete a Compose secret binding
Docker Builds
Check internal registry and isolated Build Worker admission
Create a Business+ Docker resource from Git and queue its first immutable build
Resources
Search readable Gateway resources
Pages
Get the global Pages wildcard profile
Configure or disable the global Pages wildcard profile
List safe Pages wildcard profile options
List Page Project folders
Create a Page Project folder
Reorder Page Project folders
Move Page Projects to a folder
Reorder Page Projects within a folder
Rename a Page Project folder
Delete a Page Project folder and ungroup its Projects
Move a Page Project folder
List Page Projects
Create a Page Project
List eligible Page Project placement nodes
Resolve a Page Project by slug
Get a Page Project
Update a Page Project
Delete an empty Page Project
Migrate a Page Project to another Nginx node
List Page Project runtime configurations
Update the default Page Project runtime configuration
Create or update a Page Tag runtime configuration override
Reset a Page Tag runtime configuration to the default
List Page Project Deployments
Pin or unpin a Page Deployment
Get a Page Project Deployment
Delete an unreferenced Page Deployment
List Page Project Tags
Create or move a Page Project Tag
Delete a Page Project Tag
List Page Project deploy tokens
Create a Page Project deploy token
Revoke a Page Project deploy token
Pages Deploy API
Create a resumable static Deployment upload
Append a Deployment archive chunk
Validate and store a Deployment archive
Settings
Get runtime environment settings
Update runtime environment settings
Integrations
List GitLab connectors
Create a GitLab connector
List Cloudflare connectors
Create a Cloudflare connector
Test Cloudflare connection before saving a connector
Get a Cloudflare connector
Delete a Cloudflare connector
Update a Cloudflare connector
Rotate a Cloudflare connector token
Test a Cloudflare connector
Sync a Cloudflare connector
List cached Cloudflare zones
Test GitLab connection before saving a connector
Search GitLab projects and groups before saving a connector
Get a GitLab connector
Delete a GitLab connector
Update a GitLab connector
Rotate a GitLab connector token
Get detected GitLab connector capabilities
Test a GitLab connector
Sync a GitLab connector
Get current user GitLab authorization status
Authorize the current user for a GitLab connector
Disconnect the current user from a GitLab connector
Search GitLab projects and groups for allowlist selection
List GitLab projects available for allowlist selection
Refresh cached GitLab projects for allowlist selection
Logging Folders
List logging environment folders
Create a logging environment folder
Reorder logging environment folders
Move logging environments to a folder
Reorder logging environments
Update a logging environment folder
Delete a logging environment folder
Move a logging environment folder
List logging schema folders
Create a logging schema folder
Reorder logging schema folders
Move logging schemas to a folder
Reorder logging schemas
Update a logging schema folder
Delete a logging schema folder
Move a logging schema folder
Product
API Reference
GitHub
Select theme
Dark
Light
Auto
Overview
Docker Containers
Section titled “Docker Containers”
Docker container lifecycle and inspection
Operations
Section titled “Operations”
GET
/api/docker/nodes/{nodeId}/containers
POST
/api/docker/nodes/{nodeId}/containers
GET
/api/docker/nodes/{nodeId}/containers/gpu-usage
GET
/api/docker/nodes/{nodeId}/containers/by-name/{containerName}
GET
/api/docker/nodes/{nodeId}/containers/{containerId}
DELETE
/api/docker/nodes/{nodeId}/containers/{containerId}
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/start
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/stop
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/restart
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/kill
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/rename
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/duplicate
GET
/api/docker/nodes/{nodeId}/containers/{containerId}/archive
POST
/api/docker/nodes/{nodeId}/containers/archive/plan
POST
/api/docker/nodes/{nodeId}/containers/archive
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/update
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/live-update
POST
/api/docker/nodes/{nodeId}/containers/{containerId}/recreate
GET
/api/docker/nodes/{nodeId}/containers/{containerId}/logs
GET
/api/docker/nodes/{nodeId}/containers/{containerId}/stats
GET
/api/docker/nodes/{nodeId}/containers/{containerId}/stats/history
GET
/api/docker/nodes/{nodeId}/containers/{containerId}/top
GET
/api/docker/nodes/{nodeId}/containers/{containerId}/env
PUT
/api/docker/nodes/{nodeId}/containers/{containerId}/env
