Get Database Overview

GET

/dbaas/{managed_db_id}/overview/

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

Returns, in one call, the summary a database overview needs: disk use, nodes, snapshot summary, configuration, connection details and VPC. Each part is read on its own; a part that cannot be read is null instead of failing the call. Most parts need the database to be Running. Needs the Read permission on DBaaS.

Parameters

Path Parameters

managed_db_id

required

integer

Database ID

Query Parameters

project_id

required

integer

Project ID

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 overview

Media typeapplication/json

object

code

integer

message

string

data

object

metrics

object

storage

The database’s disk use. null unless the database is Running.

object

total

string

used

string

available

string

percent

string

nodes

The database’s nodes, as in List Database Nodes.

Array<object>

nullable

object

name

The node’s name: pg- and the database ID.

string

role

string

private_ip

string

public_ip

Empty when the node has no public address.

string

status

string

vpc_ip

The node’s VPC address. Present only when a VPC is attached.

string

nullable

snapshot_summary

object

backup_enabled

true when the snapshot schedule is on.

boolean

frequency

string

retention_count

integer

next_run_at

string

nullable

total_snapshots

integer

latest_snapshot

object

name

string

status

string

backup_type

string

created_at

string

configuration

As in Get Database Configuration.

object

parameter_group

The attached parameter group; null when none is attached.

object

id

integer

name

string

status

string

extensions

Extensions installed on the database, read live. Until the database answers, the extensions set at creation.

object

status

integer

data

object

extensions

Array<string>

count

integer

errors

object

log

string

success

boolean

connection_info

As in Get Database Connection Info for application.

object

purpose

string

Allowed values: application psql

host

The database’s public address. While the database has no IP allowlist it has no public address, and this is its internal name, which cannot be reached from outside.

string

port

integer

database

The database created at launch.

string

user

The admin username set at creation.

string

password_note

string

connection_strings

The same connection in four forms. None holds the password.

object

url

string

env

string

psql

string

jdbc

string

snippets

Short code samples that read the URL from DATABASE_URL.

object

nodejs

string

python

string

django

string

sqlalchemy

string

go

string

ssl_required

Connections must use SSL.

boolean

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

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "metrics": {
      "storage": {
        "total": "98G",
        "used": "2.1G",
        "available": "96G",
        "percent": "3%"
      }
    },
    "nodes": [
      {
        "name": "pg-123",
        "role": "primary",
        "private_ip": "10.0.4.17",
        "public_ip": "203.0.113.25",
        "status": "running",
        "vpc_ip": "10.10.0.12"
      }
    ],
    "snapshot_summary": {
      "backup_enabled": true,
      "frequency": "daily",
      "retention_count": 7,
      "next_run_at": "2026-10-22T02:00:00+05:30",
      "total_snapshots": 3,
      "latest_snapshot": {
        "name": "before-migration",
        "status": "Completed",
        "backup_type": "on_demand",
        "created_at": "2026-10-21T12:00:00+00:00"
      }
    },
    "configuration": {
      "parameter_group": {
        "id": 8,
        "name": "orders-tuning",
        "status": "synced"
      },
      "extensions": {
        "status": 200,
        "data": {
          "extensions": [
            "pg_stat_statements",
            "plpgsql",
            "vector"
          ],
          "count": 3
        },
        "errors": {},
        "log": "Success",
        "success": true
      }
    },
    "connection_info": {
      "purpose": "application",
      "host": "<host>",
      "port": 5432,
      "database": "defaultdb",
      "user": "appadmin",
      "password_note": "Replace <password> with the password of 'appadmin'. In the URL form, percent-encode special characters in the password (for example @ as %40, : as %3A, / as %2F).",
      "connection_strings": {
        "url": "postgresql://appadmin:<password>@<host>:5432/defaultdb?sslmode=require",
        "env": "DATABASE_URL=postgresql://appadmin:<password>@<host>:5432/defaultdb?sslmode=require",
        "psql": "psql \"host=<host> port=5432 dbname=defaultdb user=appadmin sslmode=require\"",
        "jdbc": "jdbc:postgresql://<host>:5432/defaultdb?user=appadmin&ssl=true"
      },
      "ssl_required": true
    },
    "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
  },
  "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."
}

404

No database with that ID in the project and region.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 404,
  "message": "Bad Request",
  "data": {},
  "errors": "Invalid request! Database Not Found"
}