This page indexes every operation in Bex's pinned Render-compatible OpenAPI contract (SHA-256 c6851bc830fa…), graded against the backend's registered REST routes. bex.co serves the graded document at /content/platform-openapi.json for agents and the interactive explorer below; it does not execute these operations — live calls go to https://api.bex.co/v1.
Generated from Bex backend revision 33fb49def890 (committed 2026-09-14). That revision is the source this reference describes; it is not a statement about which build is currently deployed at api.bex.co.
Grade legend
| Grade | Meaning |
|---|---|
implemented | Registered REST handler; not on the conformance allowlist or retired-alias list |
partial | Handler exists but response shape or behaviour diverges (ADR018) or the route is a documented stub |
not-implemented | No matching handler, or a retired public alias that 404s by design |
For authentication and GraphQL, see the REST & GraphQL API guide. For CLI grades, see the CLI reference.
Bex query extensions
Bex accepts these query parameters on otherwise Render-shaped operations. They are part of the served document and the explorer below, so a Render-shaped client that never sends them behaves unchanged. Request schemas carry Bex additions too — managed Postgres plan also accepts Bex's own instance-type ids, for example.
| Parameter | Accepts | Behaviour | Operations |
|---|---|---|---|
aggregateAllMethod | MIN | MAX | AVG | How to combine a multi-replica series into one at each timestamp. Omitted, per-replica series are returned unaggregated. | get-bandwidth, get-cpu, get-cpu-target, get-http-latency, get-http-requests, get-instance-count, get-memory, get-memory-target |
confirm | string | The exact server-issued confirmation phrase required to act on a resource in a protected environment. A free-form string, not a boolean. | delete-key-value, delete-postgres, delete-service, restart-postgres, restart-service, resume-key-value, resume-postgres, resume-service, suspend-key-value, suspend-postgres, suspend-service |
dryRun | boolean | Resolve and validate the change, then return the preview without writing it. Only the literal true enables the preview; it may also be sent as a request-body field. | create-key-value, create-postgres, create-service, update-key-value, update-postgres, update-service |
kind | database | keyvalue | service | Which resource's disk to read: a managed Postgres, a managed Key Value, or a service's attached persistent disk. Omitted, the read targets a managed Postgres. | get-disk-capacity |
ownerId | string | Workspace to address. Omitted, the request resolves to the caller's selected or default workspace; authorization still checks membership. | delete-webhook, disconnect-blueprint, list-blueprint-syncs, list-webhook-events, retrieve-blueprint, retrieve-event, retrieve-webhook, update-blueprint, update-webhook |
percentage | boolean | Report the series as a percentage of the resource's limit rather than an absolute value. Only the literal true enables it. | get-bandwidth, get-cpu, get-cpu-target, get-http-latency, get-http-requests, get-instance-count, get-memory, get-memory-target |
status | delivered | failed | Restrict the attempt history to one immutable outcome. Omitted, the endpoint's attempts are returned unfiltered; any other value is rejected. | list-webhook-events |
Audit Logs
GET /organizations/{orgId}/audit-logs
GET /owners/{ownerId}/audit-logs
| Operation | Summary | Grade |
|---|---|---|
GET /organizations/{orgId}/audit-logs | List organization audit logs | not-implemented |
GET /owners/{ownerId}/audit-logs | List workspace audit logs | implemented |
Blueprints
GET /blueprints
DELETE /blueprints/{blueprintId}
GET /blueprints/{blueprintId}
PATCH /blueprints/{blueprintId}
GET /blueprints/{blueprintId}/syncs
POST /blueprints/validate
| Operation | Summary | Grade |
|---|---|---|
GET /blueprints | List Blueprints | implemented |
DELETE /blueprints/{blueprintId} | Disconnect Blueprint | implemented |
GET /blueprints/{blueprintId} | Retrieve Blueprint | implemented |
PATCH /blueprints/{blueprintId} | Update Blueprint | implemented |
GET /blueprints/{blueprintId}/syncs | List Blueprint syncs | implemented |
POST /blueprints/validate | Validate Blueprint | implemented |
Custom Domains
GET /services/{serviceId}/custom-domains
POST /services/{serviceId}/custom-domains
DELETE /services/{serviceId}/custom-domains/{customDomainNameOrID}
GET /services/{serviceId}/custom-domains/{customDomainNameOrID}
POST /services/{serviceId}/custom-domains/{customDomainNameOrID}/verify
| Operation | Summary | Grade |
|---|---|---|
GET /services/{serviceId}/custom-domains | List custom domains | partial — ADR018 §Custom domains: bex exposes pending DNS-instruction state and omits unavailable provider metadata |
POST /services/{serviceId}/custom-domains | Add custom domain | implemented |
DELETE /services/{serviceId}/custom-domains/{customDomainNameOrID} | Delete custom domain | implemented |
GET /services/{serviceId}/custom-domains/{customDomainNameOrID} | Retrieve custom domain | implemented |
POST /services/{serviceId}/custom-domains/{customDomainNameOrID}/verify | Verify DNS configuration | implemented |
Dedicated IPs
GET /dedicated-ips
POST /dedicated-ips
DELETE /dedicated-ips/{dedicatedIpId}
GET /dedicated-ips/{dedicatedIpId}
PATCH /dedicated-ips/{dedicatedIpId}
| Operation | Summary | Grade |
|---|---|---|
GET /dedicated-ips | List dedicated IPs | not-implemented |
POST /dedicated-ips | Create dedicated IP set | not-implemented |
DELETE /dedicated-ips/{dedicatedIpId} | Delete dedicated IP set | not-implemented |
GET /dedicated-ips/{dedicatedIpId} | Retrieve dedicated IP set | not-implemented |
PATCH /dedicated-ips/{dedicatedIpId} | Update dedicated IP set | not-implemented |
Deploys
GET /services/{serviceId}/deploys
POST /services/{serviceId}/deploys
GET /services/{serviceId}/deploys/{deployId}
POST /services/{serviceId}/deploys/{deployId}/cancel
POST /services/{serviceId}/rollback
| Operation | Summary | Grade |
|---|---|---|
GET /services/{serviceId}/deploys | List deploys | implemented |
POST /services/{serviceId}/deploys | Trigger deploy | implemented |
GET /services/{serviceId}/deploys/{deployId} | Retrieve deploy | implemented |
POST /services/{serviceId}/deploys/{deployId}/cancel | Cancel deploy | implemented |
POST /services/{serviceId}/rollback | Roll back deploy | implemented |
Disks
GET /disks
POST /disks
DELETE /disks/{diskId}
GET /disks/{diskId}
PATCH /disks/{diskId}
GET /disks/{diskId}/snapshots
POST /disks/{diskId}/snapshots/restore
| Operation | Summary | Grade |
|---|---|---|
GET /disks | List disks | implemented |
POST /disks | Add disk | implemented |
DELETE /disks/{diskId} | Delete disk | implemented |
GET /disks/{diskId} | Retrieve disk | implemented |
PATCH /disks/{diskId} | Update disk | implemented |
GET /disks/{diskId}/snapshots | List snapshots | implemented |
POST /disks/{diskId}/snapshots/restore | Restore snapshot | implemented |
Environment Groups
GET /env-groups
POST /env-groups
DELETE /env-groups/{envGroupId}
GET /env-groups/{envGroupId}
PATCH /env-groups/{envGroupId}
DELETE /env-groups/{envGroupId}/env-vars/{envVarKey}
GET /env-groups/{envGroupId}/env-vars/{envVarKey}
PUT /env-groups/{envGroupId}/env-vars/{envVarKey}
DELETE /env-groups/{envGroupId}/secret-files/{envVarKey}
GET /env-groups/{envGroupId}/secret-files/{envVarKey}
PUT /env-groups/{envGroupId}/secret-files/{envVarKey}
DELETE /env-groups/{envGroupId}/services/{serviceId}
POST /env-groups/{envGroupId}/services/{serviceId}
| Operation | Summary | Grade |
|---|---|---|
GET /env-groups | List environment groups | implemented |
POST /env-groups | Create environment group | implemented |
DELETE /env-groups/{envGroupId} | Delete environment group | implemented |
GET /env-groups/{envGroupId} | Retrieve environment group | implemented |
PATCH /env-groups/{envGroupId} | Update environment group | implemented |
DELETE /env-groups/{envGroupId}/env-vars/{envVarKey} | Remove environment variable | implemented |
GET /env-groups/{envGroupId}/env-vars/{envVarKey} | Retrieve environment variable | implemented |
PUT /env-groups/{envGroupId}/env-vars/{envVarKey} | Add or update environment variable | implemented |
DELETE /env-groups/{envGroupId}/secret-files/{envVarKey} | Remove secret file | implemented |
GET /env-groups/{envGroupId}/secret-files/{envVarKey} | Retrieve secret file | implemented |
PUT /env-groups/{envGroupId}/secret-files/{envVarKey} | Add or update secret file | implemented |
DELETE /env-groups/{envGroupId}/services/{serviceId} | Unlink service | implemented |
POST /env-groups/{envGroupId}/services/{serviceId} | Link service | implemented |
Events
GET /events/{eventId}
| Operation | Summary | Grade |
|---|---|---|
GET /events/{eventId} | Retrieve event | partial — ADR018 §Services & lifecycle — Service events / activity feed: deliberate partial event-detail dialect |
Key Value
GET /key-value
POST /key-value
DELETE /key-value/{redisId}
GET /key-value/{redisId}
PATCH /key-value/{redisId}
GET /key-value/{redisId}/connection-info
POST /key-value/{redisId}/resume
POST /key-value/{redisId}/suspend
| Operation | Summary | Grade |
|---|---|---|
GET /key-value | List Key Value instances | implemented |
POST /key-value | Create Key Value instance | implemented |
DELETE /key-value/{redisId} | Delete Key Value instance | implemented |
GET /key-value/{redisId} | Retrieve Key Value instance | implemented |
PATCH /key-value/{redisId} | Update Key Value instance | implemented |
GET /key-value/{redisId}/connection-info | Retrieve Key Value connection info | implemented |
POST /key-value/{redisId}/resume | Resume Key Value instance | implemented |
POST /key-value/{redisId}/suspend | Suspend Key Value instance | implemented |
Logs
GET /logs
DELETE /logs/streams/owner/{ownerId}
GET /logs/streams/owner/{ownerId}
PUT /logs/streams/owner/{ownerId}
GET /logs/streams/resource
DELETE /logs/streams/resource/{resourceId}
GET /logs/streams/resource/{resourceId}
PUT /logs/streams/resource/{resourceId}
GET /logs/subscribe
GET /logs/values
| Operation | Summary | Grade |
|---|---|---|
GET /logs | List logs | implemented |
DELETE /logs/streams/owner/{ownerId} | Delete log stream | not-implemented |
GET /logs/streams/owner/{ownerId} | Retrieve log stream | not-implemented |
PUT /logs/streams/owner/{ownerId} | Update log stream | not-implemented |
GET /logs/streams/resource | List log stream overrides | not-implemented |
DELETE /logs/streams/resource/{resourceId} | Delete log stream override | not-implemented |
GET /logs/streams/resource/{resourceId} | Retrieve log stream override | not-implemented |
PUT /logs/streams/resource/{resourceId} | Update log stream override | not-implemented |
GET /logs/subscribe | Subscribe to new logs | implemented |
GET /logs/values | List log label values | implemented |
Maintenance
GET /maintenance
GET /maintenance/{maintenanceRunID}
PATCH /maintenance/{maintenanceRunID}
POST /maintenance/{maintenanceRunID}/trigger
| Operation | Summary | Grade |
|---|---|---|
GET /maintenance | List maintenance runs | not-implemented |
GET /maintenance/{maintenanceRunID} | Retrieve maintenance run | not-implemented |
PATCH /maintenance/{maintenanceRunID} | Update maintenance run | not-implemented |
POST /maintenance/{maintenanceRunID}/trigger | Trigger maintenance run | not-implemented |
Metrics
DELETE /metrics-stream/{ownerId}
GET /metrics-stream/{ownerId}
PUT /metrics-stream/{ownerId}
GET /metrics/active-connections
GET /metrics/bandwidth
GET /metrics/bandwidth-sources
GET /metrics/cpu
GET /metrics/cpu-limit
GET /metrics/cpu-target
GET /metrics/disk-capacity
GET /metrics/disk-usage
GET /metrics/filters/application
GET /metrics/filters/http
GET /metrics/filters/path
GET /metrics/http-latency
GET /metrics/http-requests
GET /metrics/instance-count
GET /metrics/memory
GET /metrics/memory-limit
GET /metrics/memory-target
GET /metrics/replication-lag
GET /metrics/task-runs-completed
GET /metrics/task-runs-queued
| Operation | Summary | Grade |
|---|---|---|
DELETE /metrics-stream/{ownerId} | Delete metrics stream | not-implemented |
GET /metrics-stream/{ownerId} | Retrieve metrics stream | not-implemented |
PUT /metrics-stream/{ownerId} | Create or update metrics stream | not-implemented |
GET /metrics/active-connections | Get active connection count | not-implemented |
GET /metrics/bandwidth | Get bandwidth usage | implemented |
GET /metrics/bandwidth-sources | Get bandwidth usage breakdown by traffic source | not-implemented |
GET /metrics/cpu | Get CPU usage | implemented |
GET /metrics/cpu-limit | Get CPU limit | not-implemented |
GET /metrics/cpu-target | Get CPU target | implemented |
GET /metrics/disk-capacity | Get disk capacity | implemented |
GET /metrics/disk-usage | Get disk usage | not-implemented |
GET /metrics/filters/application | List queryable instance values | not-implemented |
GET /metrics/filters/http | List queryable status codes and host values | not-implemented |
GET /metrics/filters/path | List queryable paths | not-implemented |
GET /metrics/http-latency | Get HTTP latency | implemented |
GET /metrics/http-requests | Get HTTP request count | implemented |
GET /metrics/instance-count | Get instance count | implemented |
GET /metrics/memory | Get memory usage | implemented |
GET /metrics/memory-limit | Get memory limit | not-implemented |
GET /metrics/memory-target | Get memory target | implemented |
GET /metrics/replication-lag | Get replica lag | implemented |
GET /metrics/task-runs-completed | Get task runs completed count | not-implemented |
GET /metrics/task-runs-queued | Get task runs queued count | not-implemented |
Notification Settings
GET /notification-settings/overrides
GET /notification-settings/overrides/services/{serviceId}
PATCH /notification-settings/overrides/services/{serviceId}
GET /notification-settings/owners/{ownerId}
PATCH /notification-settings/owners/{ownerId}
| Operation | Summary | Grade |
|---|---|---|
GET /notification-settings/overrides | List notification overrides | not-implemented |
GET /notification-settings/overrides/services/{serviceId} | Retrieve notification override | implemented |
PATCH /notification-settings/overrides/services/{serviceId} | Update notification override | implemented |
GET /notification-settings/owners/{ownerId} | Retrieve notification settings | not-implemented |
PATCH /notification-settings/owners/{ownerId} | Update notification settings | not-implemented |
One-Off Jobs
GET /services/{serviceId}/jobs
POST /services/{serviceId}/jobs
GET /services/{serviceId}/jobs/{jobId}
POST /services/{serviceId}/jobs/{jobId}/cancel
| Operation | Summary | Grade |
|---|---|---|
GET /services/{serviceId}/jobs | List jobs | implemented |
POST /services/{serviceId}/jobs | Create job | implemented |
GET /services/{serviceId}/jobs/{jobId} | Retrieve job | implemented |
POST /services/{serviceId}/jobs/{jobId}/cancel | Cancel running job | implemented |
Postgres
GET /postgres
POST /postgres
DELETE /postgres/{postgresId}
GET /postgres/{postgresId}
PATCH /postgres/{postgresId}
GET /postgres/{postgresId}/connection-info
GET /postgres/{postgresId}/credentials
POST /postgres/{postgresId}/credentials
DELETE /postgres/{postgresId}/credentials/{username}
GET /postgres/{postgresId}/export
POST /postgres/{postgresId}/export
POST /postgres/{postgresId}/failover
GET /postgres/{postgresId}/query/processes
GET /postgres/{postgresId}/query/sizes
GET /postgres/{postgresId}/query/table-scans
GET /postgres/{postgresId}/query/top-queries
GET /postgres/{postgresId}/recovery
POST /postgres/{postgresId}/recovery
POST /postgres/{postgresId}/restart
POST /postgres/{postgresId}/resume
POST /postgres/{postgresId}/suspend
| Operation | Summary | Grade |
|---|---|---|
GET /postgres | List Postgres instances | partial — ADR018 §Managed Postgres / §Resource metadata contract: omitted unknown metadata and unsupported advanced provider fields |
POST /postgres | Create Postgres instance | implemented |
DELETE /postgres/{postgresId} | Delete Postgres instance | implemented |
GET /postgres/{postgresId} | Retrieve Postgres instance | partial — ADR018 §Managed Postgres / §Resource metadata contract: omitted unknown metadata and unsupported advanced provider fields |
PATCH /postgres/{postgresId} | Update Postgres instance | implemented |
GET /postgres/{postgresId}/connection-info | Retrieve Postgres connection info | implemented |
GET /postgres/{postgresId}/credentials | List PostgreSQL Users | not-implemented |
POST /postgres/{postgresId}/credentials | Create PostgreSQL User | not-implemented |
DELETE /postgres/{postgresId}/credentials/{username} | Delete PostgreSQL User | not-implemented |
GET /postgres/{postgresId}/export | List Postgres exports | implemented |
POST /postgres/{postgresId}/export | Create Postgres export | implemented |
POST /postgres/{postgresId}/failover | Failover Postgres instance | implemented |
GET /postgres/{postgresId}/query/processes | List live queries | not-implemented |
GET /postgres/{postgresId}/query/sizes | List database, table, and index sizes | not-implemented |
GET /postgres/{postgresId}/query/table-scans | List table scans | not-implemented |
GET /postgres/{postgresId}/query/top-queries | List top queries | not-implemented |
GET /postgres/{postgresId}/recovery | Retrieve point-in-time recovery status | not-implemented |
POST /postgres/{postgresId}/recovery | Trigger point-in-time recovery | not-implemented |
POST /postgres/{postgresId}/restart | Restart Postgres instance | implemented |
POST /postgres/{postgresId}/resume | Resume Postgres instance | implemented |
POST /postgres/{postgresId}/suspend | Suspend Postgres instance | implemented |
Projects & Environments
GET /environments
POST /environments
DELETE /environments/{environmentId}
GET /environments/{environmentId}
PATCH /environments/{environmentId}
DELETE /environments/{environmentId}/resources
POST /environments/{environmentId}/resources
GET /projects
POST /projects
DELETE /projects/{projectId}
GET /projects/{projectId}
PATCH /projects/{projectId}
| Operation | Summary | Grade |
|---|---|---|
GET /environments | List environments | implemented |
POST /environments | Create environment | implemented |
DELETE /environments/{environmentId} | Delete environment | implemented |
GET /environments/{environmentId} | Retrieve environment | implemented |
PATCH /environments/{environmentId} | Update environment | implemented |
DELETE /environments/{environmentId}/resources | Remove resources from environment | not-implemented |
POST /environments/{environmentId}/resources | Add resources to environment | not-implemented |
GET /projects | List projects | implemented |
POST /projects | Create project | implemented |
DELETE /projects/{projectId} | Delete project | implemented |
GET /projects/{projectId} | Retrieve Project | implemented |
PATCH /projects/{projectId} | Update project | implemented |
Redis (Deprecated)
GET /redis
POST /redis
DELETE /redis/{redisId}
GET /redis/{redisId}
PATCH /redis/{redisId}
GET /redis/{redisId}/connection-info
POST /redis/{redisId}/resume
POST /redis/{redisId}/suspend
| Operation | Summary | Grade |
|---|---|---|
GET /redis | List Redis instances | not-implemented |
POST /redis | Create Redis instance | not-implemented |
DELETE /redis/{redisId} | Delete Redis instance | not-implemented |
GET /redis/{redisId} | Retrieve Redis instance | not-implemented |
PATCH /redis/{redisId} | Update Redis instance | not-implemented |
GET /redis/{redisId}/connection-info | Retrieve Redis connection info | not-implemented |
POST /redis/{redisId}/resume | Resume Redis instance | not-implemented |
POST /redis/{redisId}/suspend | Suspend Redis instance | not-implemented |
Registry Credentials
GET /registrycredentials
POST /registrycredentials
DELETE /registrycredentials/{registryCredentialId}
GET /registrycredentials/{registryCredentialId}
PATCH /registrycredentials/{registryCredentialId}
| Operation | Summary | Grade |
|---|---|---|
GET /registrycredentials | List registry credentials | implemented |
POST /registrycredentials | Create registry credential | implemented |
DELETE /registrycredentials/{registryCredentialId} | Delete registry credential | implemented |
GET /registrycredentials/{registryCredentialId} | Retrieve registry credential | implemented |
PATCH /registrycredentials/{registryCredentialId} | Update registry credential | implemented |
Services
GET /services
POST /services
DELETE /services/{serviceId}
GET /services/{serviceId}
PATCH /services/{serviceId}
DELETE /services/{serviceId}/autoscaling
PUT /services/{serviceId}/autoscaling
POST /services/{serviceId}/cache/purge
GET /services/{serviceId}/env-vars
PUT /services/{serviceId}/env-vars
DELETE /services/{serviceId}/env-vars/{envVarKey}
GET /services/{serviceId}/env-vars/{envVarKey}
PUT /services/{serviceId}/env-vars/{envVarKey}
GET /services/{serviceId}/events
GET /services/{serviceId}/instances
GET /services/{serviceId}/outbound-ips
POST /services/{serviceId}/preview
POST /services/{serviceId}/restart
POST /services/{serviceId}/resume
POST /services/{serviceId}/scale
GET /services/{serviceId}/secret-files
PUT /services/{serviceId}/secret-files
DELETE /services/{serviceId}/secret-files/{envVarKey}
GET /services/{serviceId}/secret-files/{envVarKey}
PUT /services/{serviceId}/secret-files/{envVarKey}
POST /services/{serviceId}/suspend
| Operation | Summary | Grade |
|---|---|---|
GET /services | List services | partial — ADR018 §Services & lifecycle / §Resource metadata contract: optional truthful metadata and partial serviceDetails projection |
POST /services | Create service | implemented |
DELETE /services/{serviceId} | Delete service | implemented |
GET /services/{serviceId} | Retrieve service | partial — ADR018 §Services & lifecycle / §Resource metadata contract: optional truthful metadata and partial serviceDetails projection |
PATCH /services/{serviceId} | Update service | implemented |
DELETE /services/{serviceId}/autoscaling | Delete autoscaling config | implemented |
PUT /services/{serviceId}/autoscaling | Update autoscaling config | implemented |
POST /services/{serviceId}/cache/purge | Purge Web Service Cache | not-implemented |
GET /services/{serviceId}/env-vars | List environment variables | implemented |
PUT /services/{serviceId}/env-vars | Update environment variables | implemented |
DELETE /services/{serviceId}/env-vars/{envVarKey} | Delete environment variable | implemented |
GET /services/{serviceId}/env-vars/{envVarKey} | Retrieve environment variable | implemented |
PUT /services/{serviceId}/env-vars/{envVarKey} | Add or update environment variable | implemented |
GET /services/{serviceId}/events | List events | partial — ADR018 §Services & lifecycle — Service events / activity feed: deliberate partial event-detail dialect |
GET /services/{serviceId}/instances | List instances | implemented |
GET /services/{serviceId}/outbound-ips | Retrieve service outbound IPs | implemented |
POST /services/{serviceId}/preview | Create service preview (image-backed) | not-implemented |
POST /services/{serviceId}/restart | Restart service | implemented |
POST /services/{serviceId}/resume | Resume service | implemented |
POST /services/{serviceId}/scale | Scale instance count | implemented |
GET /services/{serviceId}/secret-files | List secret files | partial — ADR018 §Environment variables & secret files: list returns names without secret contents |
PUT /services/{serviceId}/secret-files | Update secret files | not-implemented |
DELETE /services/{serviceId}/secret-files/{envVarKey} | Delete secret file | implemented |
GET /services/{serviceId}/secret-files/{envVarKey} | Retrieve secret file | implemented |
PUT /services/{serviceId}/secret-files/{envVarKey} | Add or update secret file | implemented |
POST /services/{serviceId}/suspend | Suspend service | implemented |
Services - Cron Jobs
DELETE /cron-jobs/{cronJobId}/runs
POST /cron-jobs/{cronJobId}/runs
| Operation | Summary | Grade |
|---|---|---|
DELETE /cron-jobs/{cronJobId}/runs | Cancel running cron job | implemented |
POST /cron-jobs/{cronJobId}/runs | Trigger cron job run | implemented |
Services - Headers
GET /services/{serviceId}/headers
POST /services/{serviceId}/headers
PUT /services/{serviceId}/headers
DELETE /services/{serviceId}/headers/{headerId}
| Operation | Summary | Grade |
|---|---|---|
GET /services/{serviceId}/headers | List header rules | implemented |
POST /services/{serviceId}/headers | Add header rule | not-implemented |
PUT /services/{serviceId}/headers | Replace header rules | implemented |
DELETE /services/{serviceId}/headers/{headerId} | Delete header rule | not-implemented |
Services - Routes
GET /services/{serviceId}/routes
POST /services/{serviceId}/routes
PUT /services/{serviceId}/routes
DELETE /services/{serviceId}/routes/{routeId}
PATCH /services/{serviceId}/routes/{routeId}
| Operation | Summary | Grade |
|---|---|---|
GET /services/{serviceId}/routes | List redirect/rewrite rules | implemented |
POST /services/{serviceId}/routes | Add redirect/rewrite rules | not-implemented |
PUT /services/{serviceId}/routes | Update redirect/rewrite rules | implemented |
DELETE /services/{serviceId}/routes/{routeId} | Delete redirect/rewrite rule | not-implemented |
PATCH /services/{serviceId}/routes/{routeId} | Update redirect/rewrite rule priority | not-implemented |
Users
GET /users
| Operation | Summary | Grade |
|---|---|---|
GET /users | Get the authenticated user | implemented |
Webhooks
GET /webhooks
POST /webhooks
DELETE /webhooks/{webhookId}
GET /webhooks/{webhookId}
PATCH /webhooks/{webhookId}
GET /webhooks/{webhookId}/events
| Operation | Summary | Grade |
|---|---|---|
GET /webhooks | List webhooks | implemented |
POST /webhooks | Create a webhook | implemented |
DELETE /webhooks/{webhookId} | Delete a webhook | implemented |
GET /webhooks/{webhookId} | Retrieve a webhook | implemented |
PATCH /webhooks/{webhookId} | Update a webhook | implemented |
GET /webhooks/{webhookId}/events | List webhook events | implemented |
Workflow Tasks
GET /task-runs
POST /task-runs
DELETE /task-runs/{taskRunId}
GET /task-runs/{taskRunId}
GET /task-runs/events
GET /tasks
GET /tasks/{taskId}
| Operation | Summary | Grade |
|---|---|---|
GET /task-runs | List task runs | not-implemented |
POST /task-runs | Run task | not-implemented |
DELETE /task-runs/{taskRunId} | Cancel task run | not-implemented |
GET /task-runs/{taskRunId} | Retrieve task run | not-implemented |
GET /task-runs/events | Stream realtime events (SSE) | not-implemented |
GET /tasks | List tasks | not-implemented |
GET /tasks/{taskId} | Retrieve task | not-implemented |
Workflows
GET /workflows
POST /workflows
DELETE /workflows/{workflowId}
GET /workflows/{workflowId}
PATCH /workflows/{workflowId}
GET /workflowversions
POST /workflowversions
GET /workflowversions/{workflowVersionId}
| Operation | Summary | Grade |
|---|---|---|
GET /workflows | List workflows | partial — GET /v1/workflows stub returns []; not a real implementation |
POST /workflows | Create a workflow | not-implemented |
DELETE /workflows/{workflowId} | Delete workflow | not-implemented |
GET /workflows/{workflowId} | Retrieve workflow | not-implemented |
PATCH /workflows/{workflowId} | Update workflow | not-implemented |
GET /workflowversions | List workflow versions | not-implemented |
POST /workflowversions | Deploy a workflow version | not-implemented |
GET /workflowversions/{workflowVersionId} | Retrieve workflow version | not-implemented |
Workspaces
GET /owners
GET /owners/{ownerId}
GET /owners/{ownerId}/members
DELETE /owners/{ownerId}/members/{userId}
PATCH /owners/{ownerId}/members/{userId}
| Operation | Summary | Grade |
|---|---|---|
GET /owners | List workspaces | implemented |
GET /owners/{ownerId} | Retrieve workspace | implemented |
GET /owners/{ownerId}/members | List workspace members | implemented |
DELETE /owners/{ownerId}/members/{userId} | Remove workspace member | not-implemented |
PATCH /owners/{ownerId}/members/{userId} | Update workspace member role | not-implemented |
Interactive reference
The explorer below loads the same graded OpenAPI document. Test-request and client buttons are disabled on this site so the browser never calls api.bex.co from bex.co.
Loading interactive API reference…
Operations are graded against the bex backend. Partial and not-implemented endpoints are marked in the reference.