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>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "MONGODB",
      "version": "10.1",
      "mode": "CONTAINER",
      "icon_uri": "<string>",
      "environment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "service_type": "APPLICATION",
      "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": [
            "DEPLOYMENTS"
          ],
          "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[]