Skip to main content
POST
/
workspaces
/
{workspaceSlug}
/
databases
/
{databaseName}
/
compute
Create a dedicated compute instance
curl --request POST \
  --url https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: */*' \
  --data '
{
  "instanceSize": "<string>",
  "instanceName": "<string>"
}
'
{
  "instanceId": "<string>",
  "database": {
    "id": "<string>",
    "name": "<string>",
    "workspace": {
      "name": "<string>",
      "slug": "<string>",
      "id": "<string>",
      "stripe_customer_id": "<string>",
      "created": "2023-11-07T05:31:56Z"
    },
    "status": "PENDING",
    "region": "AWS_US_WEST_2",
    "expandable": true,
    "apiHost": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "deleted": "2023-11-07T05:31:56Z",
    "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

Body

*/*
​
instanceSize
string
required
Minimum string length: 1
​
instanceName
string
required
Required string length: 1 - 512

Response

Instance created.

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