Get database info

GET

databases

{database_id}

Get Database Info

curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{database_id} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/databases/{database_id}', 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://api.squarecloud.app/v2/databases/{database_id}",
  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: <authorization>"
  ],
]);

$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://api.squarecloud.app/v2/databases/{database_id}"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}")

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

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

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "name": "my-database",
    "id": "db1234567890",
    "owner": "123456789012345678",
    "cluster": "suki-cluster",
    "ram": 1024,
    "type": "mongodb",
    "port": 27017,
    "created_at": "2023-01-15T10:00:00Z"
  }
}

string

required

The API key for your account. You can find this in your account settings.

Requires an API key with the databases:read scope. Returns the static identity of a database: its name, owner, hosting cluster, allocated RAM, engine type and connection port. This is metadata only, it does not include live resource usage, use Get Database Status or Get Database Metrics for that. Useful for confirming a database’s configuration after Create Database or Edit Database, or for looking up which cluster it lives on before contacting support.

Parameters

string

required

The ID of the database. You can find this in the Square Cloud dashboard.

Response

string

Indicates whether the call was successful: success if it was, error if not.

object

The contents of the response.

Show Toggle object

string

The database’s name.

string

The database’s ID.

string

The ID of the database owner.

string

The database’s cluster.

number

The database’s RAM usage in MB.

string

The database’s type (e.g., mongodb, postgresql).

number

The database’s port.

date

The database’s creation date.

{
  "status": "success",
  "response": {
    "name": "my-database",
    "id": "db1234567890",
    "owner": "123456789012345678",
    "cluster": "suki-cluster",
    "ram": 1024,
    "type": "mongodb",
    "port": 27017,
    "created_at": "2023-01-15T10:00:00Z"
  }
}

Common errors

Code	HTTP	Meaning
`DATABASE_NOT_FOUND`	404	The database does not exist or is not owned by the caller.

CLI: squarecloud db info
SDKs: api.databases.get() (JavaScript), client.databases.get() (Python), c.Databases.Get() (Go)

Get Database Info

curl --request GET \
  --url https://api.squarecloud.app/v2/databases/{database_id} \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/databases/{database_id}', 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://api.squarecloud.app/v2/databases/{database_id}",
  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: <authorization>"
  ],
]);

$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://api.squarecloud.app/v2/databases/{database_id}"

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

	req.Header.Add("Authorization", "<authorization>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/databases/{database_id}")

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

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

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "name": "my-database",
    "id": "db1234567890",
    "owner": "123456789012345678",
    "cluster": "suki-cluster",
    "ram": 1024,
    "type": "mongodb",
    "port": 27017,
    "created_at": "2023-01-15T10:00:00Z"
  }
}

Get started

Account

Applications

Databases

Workspaces

AI

Parameters

Response

Common errors

​Parameters

​Response

​Common errors

​Related

Parameters

Response

Common errors

Related