List Databases

GET

/dbaas/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/dbaas/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

Returns the databases of the project in the region, newest first. Deleted ones are not listed. Pass page_no and per_page together to page the list. Needs the Read permission on DBaaS.

Parameters

Query Parameters

project_id

required

integer

Project ID

page_no

integer

>= 1

Page number. Paging starts only when page_no and per_page are both sent; otherwise every database comes back. A page past the last returns an empty list, and a value that is not a number returns page 1.

per_page

integer

default: 20 >= 1

Databases per page. A value that is not a whole number above 0 becomes 20.

active_iam

integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location

required

string

Allowed values: Delhi Chennai

Location

Responses

200

The databases

Media typeapplication/json

object

code

integer

message

string

total_page_number

Only with paging.

integer

total_count

Only with paging.

integer

data

Array<object>

object

id

integer

name

string

engine

string

Allowed values: postgresql

engine_version

string

status

Creating while the database is being set up, started or restarted, Running, Scaling while the disk grows, Degraded when the database is serving but its health could not be fully confirmed (Stop and Restart are also accepted from it), Stopped, Failed when the launch did not finish or a storage resize did not complete, and Terminating while it is deleted.

string

Allowed values: Creating Running Scaling Degraded Stopped Failed Terminating

cpu

VCPUs, set by the plan.

string

nullable

memory

Memory, set by the plan.

string

nullable

disk_size

Disk size in GB.

integer

nullable

sku_details

The plan: its specification under specs and its pricing under plan. null when the plan is gone.

object

endpoint_url

Public read-write address and port. null until the database first reaches Running, and while it has no IP allowlist.

string

nullable

public_ip

string

nullable

private_ip

string

nullable

deletion_protection

true when the database cannot be deleted.

boolean

ip_allowlist

IPv4 ranges allowed to reach the public endpoint.

Array<object>

object

cidr

string

label

Description of the range; empty when none was given.

string

vpc_id

integer

nullable

vpc

The VPC attachment. null when no VPC is attached.

object

id

integer

vpc_name

string

subnet_name

string

resource_type

string

resource_name

string

object_id

integer

ip_address

The database’s address in the VPC.

string

nullable

status

string

attached_at

string

nullable

created_at

string

vpc_private_ip

The database’s VPC address; null without a VPC.

string

nullable

extensions

Extensions set at creation.

Array<string>

created_by

object

id

integer

name

string

email

string

username

string

created_at

string

updated_at

string

location

string

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "total_page_number": 1,
  "total_count": 1,
  "data": [
    {
      "id": 123,
      "name": "orders-db",
      "engine": "postgresql",
      "engine_version": "16",
      "status": "Creating",
      "cpu": "4",
      "memory": "16Gi",
      "disk_size": 100,
      "endpoint_url": "<host>:5432",
      "public_ip": "203.0.113.25",
      "private_ip": "10.0.4.17",
      "deletion_protection": false,
      "ip_allowlist": [
        {
          "cidr": "203.0.113.0/24",
          "label": "office VPN"
        }
      ],
      "vpc_id": null,
      "vpc": {
        "id": 41,
        "vpc_name": "app-vpc",
        "subnet_name": "app-subnet",
        "resource_type": "Database",
        "resource_name": "orders-db",
        "object_id": 123,
        "ip_address": "10.10.0.12",
        "status": "Attached",
        "attached_at": "2026-10-21T11:20:02Z",
        "created_at": "2026-10-21T11:17:29Z"
      },
      "vpc_private_ip": null,
      "extensions": [
        "pg_stat_statements",
        "vector"
      ],
      "created_by": {
        "id": 501,
        "name": "Example User",
        "email": "user@example.com",
        "username": "user@example.com"
      },
      "created_at": "2026-10-21T11:17:29Z",
      "updated_at": "2026-10-21T11:31:05Z",
      "location": "Chennai"
    }
  ],
  "errors": {}
}

400

The project ID is missing or is not a number.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 400,
  "message": "Bad Request",
  "data": {},
  "errors": "Project ID is missing or invalid"
}

403

The caller lacks the permission the call needs on the project, or the region is not allowed.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 403,
  "message": "Forbidden",
  "data": {},
  "errors": "You don't have permission to access this service. Please verify your policy or project."
}