Skip to main content
GET
/
environment
/
{environmentId}
/
database
List environment databases
curl --request GET \
  --url https://api.qovery.com/environment/{environmentId}/database \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.qovery.com/environment/{environmentId}/database"

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

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

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

fetch('https://api.qovery.com/environment/{environmentId}/database', 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.qovery.com/environment/{environmentId}/database",
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://api.qovery.com/environment/{environmentId}/database"

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://api.qovery.com/environment/{environmentId}/database")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/environment/{environmentId}/database")

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
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "version": "10.1",
      "icon_uri": "<string>",
      "environment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "accessibility": "PRIVATE",
      "cpu": 1250,
      "instance_type": "db.t3.medium",
      "memory": 1024,
      "storage": 10,
      "annotations_groups": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "annotations": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "scopes": [],
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "labels_groups": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "labels": [
            {
              "key": "<string>",
              "value": "<string>",
              "propagate_to_cloud_provider": true
            }
          ],
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "host": "<string>",
      "port": 5432,
      "maximum_cpu": 1250,
      "maximum_memory": 1024,
      "disk_encrypted": true
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

environmentId
string<uuid>
required

Environment ID

Response

List databases

results
object[]