Skip to content
ReflexDB

Overview

ReflexDB Control Plane API 1.0.0

Section titled “ReflexDB Control Plane API 1.0.0”

The ReflexDB control plane API manages database registrations, instance provisioning, billing, and access control.

Authentication: Provide a Bearer token in the Authorization header. Accepted token types:

  • Cognito JWT (eyJ...) — issued by the dashboard login flow
  • Management API key (rmk_<id>.<secret>) — created via POST /v1/account/management-keys

Admin routes (/v1/admin/...) require the reflexdb-admins Cognito group.

Information

  • OpenAPI version: 3.0.3

Operations

Section titled “ Operations ”
GET
/databases
POST
/databases
GET
/databases/{id}
DELETE
/databases/{id}
PATCH
/databases/{id}
POST
/databases/{id}/terminate
GET
/databases/{id}/config
PUT
/databases/{id}/config
DELETE
/databases/{id}/config
GET
/databases/{id}/config/download
GET
/databases/{id}/schema
POST
/databases/{id}/provision
POST
/databases/{id}/rebuild
GET
/databases/{id}/instance
GET
/databases/{id}/transfer
GET
/databases/{id}/build-logs
GET
/databases/{id}/terraform-logs
POST
/databases/{id}/pause
POST
/databases/{id}/resume
GET
/databases/{id}/audit-log
POST
/databases/{id}/notifications/dismiss
GET
/databases/{id}/openapi.json
GET
/databases/{id}/doc-settings
PUT
/databases/{id}/doc-settings
POST
/databases/{id}/reconfigure
GET
/databases/{id}/builds
POST
/databases/{id}/redeploy
GET
/databases/{id}/metrics
POST
/databases/{id}/pause-replication
POST
/databases/{id}/resume-replication
GET
/databases/{id}/instance-logs
GET
/databases/{dbId}/api-keys
POST
/databases/{dbId}/api-keys
DELETE
/databases/{dbId}/api-keys/{keyId}
POST
/account/accept-tos
GET
/account
DELETE
/account
PATCH
/account
GET
/account/usage
GET
/account/audit-log
POST
/billing/checkout
POST
/billing/portal
POST
/billing/overage
GET
/account/management-keys
POST
/account/management-keys
DELETE
/account/management-keys/{keyId}
GET
/databases/{id}/webhooks
POST
/databases/{id}/webhooks
DELETE
/databases/{id}/webhooks/{webhookId}
GET
/databases/{id}/webhooks/{webhookId}/deliveries
GET
/system/health
GET
/system/builds
GET
/admin/customers
GET
/admin/customers/{id}
DELETE
/admin/customers/{id}
PATCH
/admin/customers/{id}/plan
GET
/admin/queue
GET
/admin/dlq
DELETE
/admin/dlq/build/{receiptHandle}
POST
/admin/dlq/build/{receiptHandle}/replay
POST
/admin/customers/{id}/deprovision
POST
/admin/redeploy-sidecar
POST
/admin/customers/{id}/build-credits
POST
/admin/databases/{id}/reset
GET
/connections
POST
/connections
GET
/connections/{id}
DELETE
/connections/{id}
PATCH
/connections/{id}
POST
/connections/test-connection
POST
/connections/{id}/test-connection
GET
/databases/{id}/uptime
GET
/terminated-databases
DELETE
/terminated-databases/{id}
DELETE
/databases/{id}/desired-state
POST
/databases/{id}/resize
POST
/databases/{id}/reload
PATCH
/admin/customers/{id}/overage
POST
/admin/customers/{id}/restore
GET
/admin/customers/{id}/aws-resources
GET
/admin/maintenance-mode
POST
/admin/maintenance-mode
POST
/admin/dedicated-alb/{customerId}/{region}/enable
DELETE
/admin/dedicated-alb/{customerId}/{region}/enable
POST
/admin/dedicated-alb/{customerId}/{region}/deactivate
POST
/admin/databases/{id}/recover-build
POST
/admin/databases/{id}/terminate
POST
/admin/databases/{id}/force-destroy
GET
/account/usage/history
GET
/account/dedicated-alb
POST
/account/dedicated-alb/{region}/activate
GET
/account/team
POST
/account/team/invite
DELETE
/account/team/invites/{inviteId}
DELETE
/account/team/members/{memberId}
POST
/invite/accept

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

Cognito JWT (eyJ...) or management API key (rmk_<id>.<secret>)

Security scheme type: http