Jump to Content
Open API spec
API Reference
API Reference
Open API spec
API Reference
Services - Routes
Search
All
Pages
Start typing to search…
JUMP TO
Render Public API
Introduction
Authentication
Pagination
Filtering Results
Rate Limiting
PATCH Requests
Blueprints
List Blueprints
get
Retrieve Blueprint
get
Update Blueprint
patch
Disconnect Blueprint
del
List Blueprint syncs
get
Custom Domains
List custom domains
get
Add custom domain
post
Retrieve custom domain
get
Delete custom domain
del
Verify DNS configuration
post
Deploys
List deploys
get
Trigger deploy
post
Retrieve deploy
get
Cancel deploy
post
Roll back deploy
post
Disks
List disks
get
Add disk
post
Retrieve disk
get
Update disk
patch
Delete disk
del
List snapshots
get
Restore snapshot
post
Environment Groups
List environment groups
get
Create environment group
post
Retrieve environment group
get
Update environment group
patch
Delete environment group
del
Link service
post
Unlink service
del
Retrieve environment variable
get
Add or update environment variable
put
Remove environment variable
del
Retrieve secret file
get
Add or update secret file
put
Remove secret file
del
Logs
List logs
get
Subscribe to new logs
get
List log label values
get
Retrieve log stream
get
Update log stream
put
Delete log stream
del
List log stream overrides
get
Retrieve log stream override
get
Update log stream override
put
Delete log stream override
del
Maintenance
List maintenance runs
get
Retrieve maintenance run
get
Update maintenance run
patch
Trigger maintenance run
post
Metrics
Retrieve metrics stream
get
Create or update metrics stream
put
Delete metrics stream
del
Get CPU usage
get
Get CPU limit
get
Get CPU target
get
Get memory usage
get
Get memory limit
get
Get memory target
get
Get HTTP request count
get
Get HTTP latency
get
Get bandwidth usage
get
Get disk usage
get
Get bandwidth usage breakdown by traffic source
get
Get disk capacity
get
Get instance count
get
Get active connection count
get
Get replica lag
get
List queryable instance values
get
List queryable status codes and host values
get
List queryable paths
get
Notification Settings
Retrieve notification settings
get
Update notification settings
patch
List notification overrides
get
Retrieve notification override
get
Update notification override
patch
One-Off Jobs
List jobs
get
Create job
post
Retrieve job
get
Cancel running job
post
Workspaces
List workspaces
get
Retrieve workspace
get
List workspace members
get
Postgres
List Postgres instances
get
Create Postgres instance
post
Retrieve Postgres instance
get
Update Postgres instance
patch
Delete Postgres instance
del
Retrieve Postgres connection info
get
Retrieve point-in-time recovery status
get
Trigger point-in-time recovery
post
Suspend Postgres instance
post
Resume Postgres instance
post
Restart Postgres instance
post
Failover Postgres instance
post
List Postgres exports
get
Create Postgres export
post
Projects & Environments
List projects
get
Create project
post
Retrieve Project
get
Update project
patch
Delete project
del
Create environment
post
List environments
get
Retrieve environment
get
Update environment
patch
Delete environment
del
Add resources to environment
post
Remove resources from environment
del
Key Value
List Key Value instances
get
Create Key Value instance
post
Retrieve Key Value instance
get
Update Key Value instance
patch
Delete Key Value instance
del
Retrieve Key Value connection info
get
Redis
List Redis instances
get
Create Redis instance
post
Retrieve Redis instance
get
Update Redis instance
patch
Delete Redis instance
del
Retrieve Redis connection info
get
Registry Credentials
List registry credentials
get
Create registry credential
post
Retrieve registry credential
get
Update registry credential
patch
Delete registry credential
del
Services
Service object fields
List services
get
Create service
post
Retrieve service
get
Update service
patch
Delete service
del
List environment variables
get
Purge Web Service Cache
post
Update environment variables
put
Retrieve environment variable
get
Add or update environment variable
put
Delete environment variable
del
List secret files
get
Update secret files
put
Retrieve secret file
get
Add or update secret file
put
Delete secret file
del
List events
get
Suspend service
post
Resume service
post
Restart service
post
Scale instance count
post
Update autoscaling config
put
Delete autoscaling config
del
Create service preview (image-backed)
post
List instances
get
Services - Cron Jobs
Trigger cron job run
post
Cancel running cron job
del
Services - Headers
List header rules
get
Add header rule
post
Replace header rules
put
Delete header rule
del
Services - Routes
List redirect/rewrite rules
get
Add redirect/rewrite rules
post
Update redirect/rewrite rule priority
patch
Update redirect/rewrite rules
put
Delete redirect/rewrite rule
del
Users
Get the authenticated user
get
Events
Retrieve event
get
Audit Logs
List workspace audit logs
get
List organization audit logs
get
Webhooks
Create a webhook
post
List webhooks
get
Retrieve a webhook
get
Update a webhook
patch
Delete a webhook
del
List webhook events
get
Services
Deploys
Services - Headers
Services - Routes
Custom Domains
Early Access: Workflows
List all workflows
get
Create a workflow
post
Get a workflow
get
Update a workflow
patch
Delete a workflow
del
List workflow versions
get
Deploy a workflow version
post
Get a workflow version
get
List tasks
get
Get a task
get
List task runs
get
Run a task
post
Stream realtime events (SSE)
get
Get a task run
get
Cancel a task run
del
Services - Routes
