Skip to main content
GET
/
workspaces
/
{workspaceSlug}
/
databases
/
{databaseName}
/
compute
/
{instanceId}
Describe a dedicated compute instance
curl --request GET \
  --url https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute/{instanceId} \
  --header 'Authorization: Bearer <token>'
[
  {
    "instanceId": "<string>",
    "database": {
      "id": "<string>",
      "name": "<string>",
      "workspace": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "stripe_customer_id": "<string>",
        "created": "2023-11-07T05:31:56Z"
      },
      "status": "PENDING",
      "region": "AWS_US_WEST_2",
      "expandable": true,
      "created": "2023-11-07T05:31:56Z",
      "deleted": "2023-11-07T05:31:56Z",
      "apiHost": "<string>",
      "dbHost": "<string>",
      "sharded": true
    },
    "instanceName": "<string>",
    "instanceType": {
      "id": "<string>",
      "computeSize": "<string>",
      "memory": "<string>",
      "hourlyCost": 123
    },
    "desiredInstanceType": {
      "id": "<string>",
      "computeSize": "<string>",
      "memory": "<string>",
      "hourlyCost": 123
    },
    "status": "PENDING",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "deleted": "2023-11-07T05:31:56Z"
  }
]

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
instanceId
string
required

Response

Dedicated compute instance details

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>
I