v1
latestSwagger 2.02026-07-172964242.9 KBDatabase
List databases
Lists all databases in the cluster.
get/v1/databases
Query parameters
includestring[]
Optional fields to include in each database response. Supported values: available_upgrades.
Response
OK response.
Example response
{
"databases": [
{
"created_at": "2025-06-17T20:05:10Z",
"id": "inventory",
"instances": [
{
"connection_info": {
"addresses": [
"10.24.34.2",
"i-0123456789abcdef.ec2.internal"
],
"port": 5432
},
"created_at": "2025-06-17T20:05:10Z",
"host_id": "us-east-1",
"id": "inventory-n1-689qacsi",
"node_name": "n1",
"postgres": {
"patroni_state": "running",
"role": "primary",
"version": "18.1"
},
"spock": {
"read_only": "off",
"subscriptions": [
{
"name": "sub_n1n3",
"provider_node": "n3",
"status": "replicating"
},
{
"name": "sub_n1n2",
"provider_node": "n2",
"status": "replicating"
}
],
"version": "4.0.10"
},
"state": "available",
"status_updated_at": "2025-06-17T20:05:10Z",
"updated_at": "2025-06-17T20:05:10Z"
},
{
"connection_info": {
"addresses": [
"10.24.35.2",
"i-058731542fee493f.ec2.internal"
],
"port": 5432
},
"created_at": "2025-06-17T20:05:10Z",
"host_id": "ap-south-1",
"id": "inventory-n2-9ptayhma",
"node_name": "n2",
"postgres": {
"patroni_state": "running",
"role": "primary",
"version": "18.1"
},
"spock": {
"read_only": "off",
"subscriptions": [
{
"name": "sub_n2n1",
"provider_node": "n1",
"status": "replicating"
},
{
"name": "sub_n2n3",
"provider_node": "n3",
"status": "replicating"
}
],
"version": "4.0.10"
},
"state": "available",
"status_updated_at": "2025-06-17T20:05:10Z",
"updated_at": "2025-06-17T20:05:10Z"
},
{
"connection_info": {
"addresses": [
"10.24.36.2",
"i-494027b7b53f6a23.ec2.internal"
],
"port": 5432
},
"created_at": "2025-06-17T20:05:10Z",
"host_id": "eu-central-1",
"id": "inventory-n3-ant97dj4",
"node_name": "n3",
"postgres": {
"patroni_state": "running",
"role": "primary",
"version": "18.1"
},
"spock": {
"read_only": "off",
"subscriptions": [
{
"name": "sub_n3n1",
"provider_node": "n1",
"status": "replicating"
},
{
"name": "sub_n3n2",
"provider_node": "n2",
"status": "replicating"
}
],
"version": "4.0.10"
},
"state": "available",
"status_updated_at": "2025-06-17T20:05:10Z",
"updated_at": "2025-06-17T20:05:10Z"
}
],
"state": "available",
"updated_at": "2025-06-17T20:05:10Z"
},
{
"created_at": "2025-06-12T15:10:05Z",
"id": "storefront",
"instances": [
{
"connection_info": {
"addresses": [
"10.24.34.2",
"i-0123456789abcdef.ec2.internal"
],
"port": 6432
},
"created_at": "2025-06-12T15:10:05Z",
"host_id": "us-east-1",
"id": "storefront-n1-689qacsi",
"node_name": "n1",
"postgres": {
"patroni_state": "running",
"role": "primary",
"version": "18.1"
},
"spock": {
"read_only": "off",
"subscriptions": [
{
"name": "sub_n1n3",
"provider_node": "n3",
"status": "replicating"
},
{
"name": "sub_n1n2",
"provider_node": "n2",
"status": "replicating"
}
],
"version": "4.0.10"
},
"state": "available",
"status_updated_at": "2025-06-17T20:05:10Z",
"updated_at": "2025-06-12T15:10:05Z"
},
{
"connection_info": {
"addresses": [
"10.24.35.2",
"i-058731542fee493f.ec2.internal"
],
"port": 6432
},
"created_at": "2025-06-12T15:10:05Z",
"host_id": "ap-south-1",
"id": "storefront-n2-9ptayhma",
"node_name": "n2",
"postgres": {
"patroni_state": "running",
"role": "primary",
"version": "18.1"
},
"spock": {
"read_only": "off",
"subscriptions": [
{
"name": "sub_n2n1",
"provider_node": "n1",
"status": "replicating"
},
{
"name": "sub_n2n3",
"provider_node": "n3",
"status": "replicating"
}
],
"version": "4.0.10"
},
"state": "available",
"status_updated_at": "2025-06-17T20:05:10Z",
"updated_at": "2025-06-12T15:10:05Z"
},
{
"connection_info": {
"addresses": [
"10.24.36.2",
"i-494027b7b53f6a23.ec2.internal"
],
"port": 6432
},
"created_at": "2025-06-12T15:10:05Z",
"host_id": "eu-central-1",
"id": "storefront-n3-ant97dj4",
"node_name": "n3",
"postgres": {
"patroni_state": "running",
"role": "primary",
"version": "18.1"
},
"spock": {
"read_only": "off",
"subscriptions": [
{
"name": "sub_n3n1",
"provider_node": "n1",
"status": "replicating"
},
{
"name": "sub_n3n2",
"provider_node": "n2",
"status": "replicating"
}
],
"version": "4.0.10"
},
"state": "available",
"status_updated_at": "2025-06-17T20:05:10Z",
"updated_at": "2025-06-12T15:10:05Z"
}
],
"state": "available",
"updated_at": "2025-06-12T15:10:05Z"
}
]
}