List Managed Databases

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

Display all Managed Databases accessible to your user, regardless of engine type. For more detailed information on a particular database instance, make a request to its instance_uri.

linode-cli databases list


Learn more...

databases:read_only


Learn more...

Responses

Response body

object

page

integer

Read-only The current page.

pages

integer

Read-only The total number of pages.

results

integer

Read-only The total number of results.

data

array of objects

data

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.

mysql postgresql

fork

object

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

hosts

object

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

integer

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

instance_uri

string

Read-only Append this to https://api.linode.com to run commands for 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.

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.

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/instances?page=1&page_size=100' \
3
     --header 'accept: application/json'


xxxxxxxxxx
50
}
1
{
2
  "data": [
3
    {
4
      "allow_list": [
5
        "192.0.2.202/24",
6
        "192.0.2.14/24"
7
      ],
8
      "cluster_size": 3,
9
      "created": "2022-01-01T00:01:01",
10
      "encrypted": true,
11
      "engine": "mysql",
12
      "fork": {
13
        "restore_time": "2024-10-14T19:55:12",
14
        "source": "176881"
15
      },
16
      "hosts": {
17
        "primary": "lin-123-456-mysql-mysql-primary.servers.linodedb.net",
18
        "secondary": "lin-123-456-mysql-primary-private.servers.linodedb.net"
19
      },
20
      "id": 123,
21
      "instance_uri": "/v4/databases/mysql/instances/123",
22
      "label": "example-db",
23
      "members": {
24
        "45.56.110.70": "primary",
25
        "45.79.159.239": "failover",

200Returns a paginated list of all accessible Managed Databases on your account.

defaultSee Errors for the range of possible error response codes.