Skip to main content
POST
Create Postgres Cluster

Authorizations

Authorization
string
header
required

A Fly API token with access to the requested organization or resource. Send it as Authorization: Bearer <Fly API token>.

Body

application/json

Cluster details

org_slug
string
required

Slug of the organization that will own the cluster, or "personal" for the caller's personal organization.

Example:

"my-org"

plan
enum<string>
required

Plan slug selecting CPU, memory, and disk sizing. Matched case-insensitively.

Available options:
basic,
starter,
launch,
scale,
Performance
Example:

"basic"

region
string
required

Fly region code where the cluster's primary runs.

Example:

"iad"

disk_size_gb
integer

Disk size in gigabytes.

Required range: 10 <= x <= 1000
Example:

10

name
string

Name for the cluster. A name is generated when omitted.

pg_major_version
enum<string>

Postgres major version.

Available options:
16,
17
Example:

"17"

pool_mode
enum<string>

Connection pooler mode.

Available options:
session,
transaction
Example:

"transaction"

postgis_enabled
boolean

Enable PostGIS support, required to later enable PostGIS extensions.

Response

Cluster accepted for provisioning

data
object