Skip to main content
GET
List dedicated compute instances for a database

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceSlug
string
required
databaseName
string
required

Query Parameters

start
string<date-time>

The start of a time window to search for active instances

end
string<date-time>

The end of a time window to search for active instances

Response

Instance list retrieved.

instanceId
string
required
database
object
required
instanceName
string
required
instanceType
object
required
desiredInstanceType
object
required
status
enum<string>
required
Available options:
PENDING,
PROVISIONING,
READY,
RESIZING,
DELETING,
FAILED,
TERMINATED
created
string<date-time>
updated
string<date-time>
deleted
string<date-time>