Skip to content
ReflexDB

Get connection

GET
/connections/{id}
 
curl --request GET \
  --url https://api.reflexdb.cloud/v1/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid

Connection ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
id
required
string format: uuid
customerId
required
string format: uuid
name
required
string
backend
required

Source database engine

string
Allowed values: mysql postgres mssql
mysqlHost
required
string
mysqlPort
required
integer
>= 1 <= 65535
availableSchemas
required

MySQL database names available to instances on this connection

Array<string>
mysqlUser
required
string
allowedSyncModes
required

Sync modes available to instances

Array<string>
Allowed values: poll binlog logical cdc
minSyncInterval
required

Minimum polling interval in seconds — instances may use a higher value

integer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
databases
required
Array<object>
Database

A database instance config and its current lifecycle status

object
id
required
string format: uuid
customerId
required
string format: uuid
connectionId
required

The connection that provides source MySQL credentials

string format: uuid
name
required
string
mysqlDb
required

The MySQL schema on the source server for this instance

string
syncMode
required

Sync mode for this instance

string
Allowed values: poll binlog logical cdc
syncInterval
required

Polling interval in seconds (>= connection minSyncInterval)

integer
taskCpu
required

ECS task vCPU units (256 = 0.25 vCPU)

integer
taskMemoryMb
required

ECS task memory in MiB

integer
logLevel
required
string
Allowed values: info debug warn error
status
required
string
Allowed values: registered building deploying running pausing paused resuming terminating terminated failed stopped
lastError
string
nullable
endpointUrl

HTTPS base URL of the running instance

string
nullable
healthStatus
string
nullable
Allowed values: ok degraded unreachable cap_exceeded
buildComputeOverride

Forced CodeBuild compute tier for this instance’s builds; null = auto-select

string
nullable
instanceSize
required
string
Allowed values: nano small medium large xlarge 2xlarge
region
required

AWS region this instance is deployed to

string
binlogServerId
integer
nullable
desiredState

Queued goal — reconciler drives the instance toward this state

string
nullable
reflexdbCustomDomain

Vanity subdomain (Teams+ plan). When set, <value>.reflexdb.cloud resolves to this instance.

string
nullable
pauseSchedule

Recurring pause/resume schedule (UTC). null when no schedule is configured.

object
pauseAt
required

HH:MM UTC

string
resumeAt
required

HH:MM UTC

string
days
required

0=Sun…6=Sat; empty = every day

Array<integer>
tags
required
Array<object>
Tag

A label attached to a database for organisation

object
label
required
string
<= 30 characters
color
required
string
Allowed values: gray red orange yellow green teal blue purple
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example 
{
  "backend": "mysql",
  "allowedSyncModes": [
    "poll"
  ],
  "databases": [
    {
      "syncMode": "poll",
      "logLevel": "info",
      "status": "registered",
      "healthStatus": "ok",
      "instanceSize": "nano",
      "tags": [
        {
          "color": "gray"
        }
      ]
    }
  ]
}

403

Section titled “403 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404 ”

Default Response

Media type application/json
Error
object
error
required
string
message
string
Example generated
{
  "error": "example",
  "message": "example"
}