Get instance status

GET

/databases/{id}/instance

const url = 'https://api.reflexdb.cloud/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Returns the database record, current instance health, and latest build in a single response. This is the primary polling endpoint for the dashboard.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

Database ID

Responses

200

Default Response

application/json

object

database

required

Subset of database fields relevant to instance management

object

key

additional properties

any

connection

required

object

minSyncInterval

required

number

allowedSyncModes

required

Array<string>

availableSchemas

required

Array<string>

deployedInstanceConfig

required

object

instanceSize

required

string

taskCpu

required

number

taskMemoryMb

required

number

syncMode

required

string

syncInterval

required

number

logLevel

required

string

safetyNet

required

number

hasPendingChanges

required

boolean

instance

required

Instance

A running ECS task serving the reflex-server binary

object

required

string format: uuid

databaseId

required

string format: uuid

buildId

string format: uuid

nullable

ecsServiceArn

string

nullable

endpointUrl

string

nullable

healthStatus

string

nullable

Allowed values: ok degraded unreachable cap_exceeded

snapshotAgeMs

Age of the in-memory snapshot in milliseconds

integer

nullable

swapCount

Number of atomic snapshot swaps since start

integer

nullable

rowCounts

object

key

additional properties

integer

lastHealthCheck

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

latestBuild

required

Build

A CodeBuild job that compiles the reflex-server binary for an instance

object

required

string format: uuid

databaseId

required

string format: uuid

codebuildId

string

nullable

imageUri

string

nullable

status

required

string

Allowed values: queued in_progress succeeded failed

logsUrl

string

nullable

startedAt

string format: date-time

nullable

finishedAt

string format: date-time

nullable

buildDurationSeconds

Wall-clock build time in seconds

integer

nullable

computeTypeUsed

CodeBuild compute tier used (e.g. BUILD_GENERAL1_LARGE)

string

nullable

costEstimateCents

Estimated build cost in USD cents

integer

nullable

createdAt

required

string format: date-time

allowedActions

required

AllowedActions

Action availability matrix — which operations are valid given the current database status and desired state

object

provision

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

rebuild

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

reconfigure

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

redeploy

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

resize

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

pause

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

resume

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

terminate

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

delete

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

reload

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

pause-replication

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

resume-replication

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

cancel-goal

required

ActionAvailability

Whether a specific user action is allowed given the current database state

object

allowed

required

boolean

mode

Immediate: executed now; queued: deferred via desired_state

string

Allowed values: immediate queued

reason

Why the action is blocked (present when allowed=false)

string

notifications

required

Array<object>

object

required

string format: uuid

eventType

required

string

message

required

string

detail

string

nullable

severity

required

string

Allowed values: success error info

sticky

required

boolean

createdAt

required

string format: date-time

unseenCount

required

integer

skippedCount

required

Number of older notifications auto-skipped (user should check audit log)

integer

computeUnitsLimit

required

number

maxInstanceSize

required

Maximum instance size available on this plan

string

pollModeMinSyncInterval

required

Minimum sync interval (seconds) for poll-mode instances on this plan

number

dataTransferGBPerMonth

required

Monthly data transfer allowance in GB for this plan

number

Example

{
  "instance": {
    "healthStatus": "ok"
  },
  "latestBuild": {
    "status": "queued"
  },
  "allowedActions": {
    "provision": {
      "mode": "immediate"
    },
    "rebuild": {
      "mode": "immediate"
    },
    "reconfigure": {
      "mode": "immediate"
    },
    "redeploy": {
      "mode": "immediate"
    },
    "resize": {
      "mode": "immediate"
    },
    "pause": {
      "mode": "immediate"
    },
    "resume": {
      "mode": "immediate"
    },
    "terminate": {
      "mode": "immediate"
    },
    "delete": {
      "mode": "immediate"
    },
    "reload": {
      "mode": "immediate"
    },
    "pause-replication": {
      "mode": "immediate"
    },
    "resume-replication": {
      "mode": "immediate"
    },
    "cancel-goal": {
      "mode": "immediate"
    }
  },
  "notifications": [
    {
      "severity": "success"
    }
  ]
}

403

Default Response

application/json

Error

object

error

required

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

Default Response

application/json

Error

object

error

required

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

Get instance status

Authorizations

Parameters

Path Parameters

Responses

200

Example

403

Example generated

404

Example generated

Example ^generated

Example ^generated