Skip to main content
GET
/
workspaces
/
{workspaceSlug}
/
databases
/
{databaseName}
/
compute
List dedicated compute instances for a database
curl --request GET \
  --url https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/compute")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "instanceId": "<string>",
    "database": {
      "id": "<string>",
      "name": "<string>",
      "workspace": {
        "name": "<string>",
        "slug": "<string>",
        "id": "<string>",
        "stripe_customer_id": "<string>",
        "created": "2023-11-07T05:31:56Z"
      },
      "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
    },
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "deleted": "2023-11-07T05:31:56Z"
  }
]
{
  "message": "<string>",
  "statusCode": 123
}
{
  "message": "<string>",
  "statusCode": 123
}

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>