Get a PostgreSQL Managed Database

get https://api.linode.com/{apiVersion}/databases/postgresql/instances/{instanceId}

Display information for a single, accessible PostgreSQL Managed Database.

linode-cli databases postgresql-view 123


Learn more...

databases:read_only


Learn more...

Responses

Response body

object

allow_list

array of strings

Controls access to the Managed Database.

Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked.
A standalone value of 0.0.0.0/0 allows all IP addresses access to the Managed Database.
An empty array ([]) blocks all public and private connections to the Managed Database.

allow_list

cluster_size

integer

Defaults to 1

The number of Linode instance nodes deployed to the Managed Database.

Choose 3 nodes to create a high availability cluster that consists of one primary node and two replica nodes.
A 2 node cluster is only available with a dedicated plan. It consists of one primary node and one replica node.

1 2 3

created

date-time

Read-only When this Managed Database was created.

encrypted

boolean

Defaults to true

Read-only Whether the Managed Databases is encrypted. Currently required to be true.

engine

string

Filterable, Read-only The Managed Database engine type.

fork

object

Details on the database that was the target of the fork. Only exists if the database was forked from another.

restore_time

date-time

The database timestamp from which it was restored. This is not when the fork was created.

source

integer

The instance id of the database that was forked from.

hosts

object

Read-only The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.

primary

string | null

The primary host for the Managed Database.

secondary

string | null

The secondary/private network host for the Managed Database. A private network host and a private IP can only be used to access a database cluster from Linodes in the same data center and will not incur transfer costs.

📘
The secondary hostname is publicly visible and accessible.

integer

Read-only A unique ID that can be used to identify and reference the Managed Database.

label

string

length between 3 and 32

Filterable A unique, user-defined string referring to the Managed Database. This string needs to be unique per Managed Database engine type.

members

object

Read-only A mapping between IP addresses and strings designating them as primary or failover.

Has additional fields

oldest_restore_time

date-time

Read-only The oldest time to which a database can be restored.

platform

string

Filterable, Read-only The back-end platform for relational databases used by the service.

rdbms-legacy rdbms-default

port

integer

Read-only The access port for this Managed Database.

region

string

Filterable The Region ID for the Managed Database.

ssl_connection

boolean

Defaults to true

Currently required to be true. Whether to require SSL credentials to establish a connection to the Managed Database.

Run the Get managed PostgreSQL database credentials operation for access information.

status

string

Filterable, Read-only The operating status of the Managed Database.

provisioning active suspending suspended resuming failed degraded updating resizing

total_disk_size_gb

integer

Read-only The total disk size of the database, in GB.

type

string

Filterable The Linode Instance type used by the Managed Database for its nodes.

updated

date-time

Read-only When this Managed Database was last updated.

updates

object

Configuration settings for automated patch update maintenance for the Managed Database.

day_of_week

integer

1 to 7

The numeric reference for the day of the week to perform maintenance. 1 is Monday, 2 is Tuesday, through to 7 which is Sunday.

duration

integer

1 to 3

The maximum maintenance window time in hours.

frequency

string

Defaults to weekly

How frequently maintenance occurs. Currently can only be weekly.

weekly

hour_of_day

integer

0 to 23

The hour to begin maintenance based in UTC time.

pending

array of objects

Read-only An array of pending updates.

pending

object

deadline

date-time | null

The time when a mandatory update needs to be applied.

description

string

A description of the update.

planned_for

date-time | null

The date and time a maintenance update will be applied.

used_disk_size_gb

integer

Read-only The amount of space currently in use in the database, in GB.

version

string

Filterable The Managed Database engine version.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.linode.com/v4/databases/postgresql/instances/instanceId \
3
     --header 'accept: application/json'


xxxxxxxxxx
42
}
1
{
2
  "allow_list": [
3
    "203.0.113.1/32",
4
    "192.0.1.0/24"
5
  ],
6
  "cluster_size": 3,
7
  "created": "2022-01-01T00:01:01",
8
  "encrypted": true,
9
  "engine": "postgresql",
10
  "fork": {
11
    "restore_time": "2024-10-14 19:55:12",
12
    "source": 176881
13
  },
14
  "hosts": {
15
    "primary": "lin-0000-000-pgsql-primary.servers.linodedb.net",
16
    "secondary": "lin-0000-000-pgsql-primary-private.servers.linodedb.net"
17
  },
18
  "id": 123,
19
  "label": "example-db",
20
  "members": {
21
    "45.56.110.70": "primary",
22
    "45.79.159.239": "failover"
23
  },
24
  "oldest_restore_time": "2024-10-03 20:48:05",
25
  "platform": "rdbms-default",

200Returns information for a single PostgreSQL Managed Database.

📘

defaultSee Errors for the range of possible error response codes.