Fly.io
Postgres Clusters

Get Postgres Cluster

View as Markdown

Get details of a specific Managed Postgres cluster.

GET
/v1/postgres/{postgres_cluster_id}

Get details of a specific Managed Postgres cluster.

Authorization

bearerAuth
AuthorizationBearer <token>

A Fly.io access token. Create one with fly tokens create.

In: header

Path Parameters

postgres_cluster_id*string

Managed Postgres Cluster ID

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/postgres/string"
{  "data": {    "attached_apps": [      {        "name": "string"      }    ],    "cpu_kind": "shared",    "cpus": 2,    "created_at": "string",    "disk_size_gb": 10,    "endpoints": {      "primary": {        "direct": {          "host": "string",          "port": 0        },        "pooler": {          "host": "string",          "port": 0        }      }    },    "id": "string",    "memory_mb": 1024,    "name": "string",    "organization": {      "name": "string",      "slug": "string"    },    "pg_major_version": "17",    "plan": "basic",    "postgis_enabled": true,    "region": "iad",    "replicas": 1,    "status": "ready"  }}
{  "error": "string"}

Create Postgres Cluster POST

Create a Managed Postgres cluster for the organization named in the request body. Provisioning is asynchronous, and a name is generated when one is not supplied.

Delete Postgres Cluster DELETE

Delete a Managed Postgres cluster. The cluster is marked for deletion and removed asynchronously.