---
title: "List Postgres instances"
method: GET
path: "/postgres"
tags: ["Postgres"]
---

# List Postgres instances

`GET /postgres`

List Postgres instances matching the provided filters. If no filters are provided, all Postgres instances are returned.

## Query parameters

- `name` string[]
- `region` Region[]
- `suspended` string[]
- `createdBefore` string, date-time
- `createdAfter` string, date-time
- `updatedBefore` string, date-time
- `updatedAfter` string, date-time
- `ownerId` string[]
- `environmentId` string[]
- `includeReplicas` boolean
- `cursor` string
- `limit` integer — Defaults to 20

## Response `200`

OK

- PostgresWithCursor[]
  - `postgres` Postgres, required
    - `id` string, required
    - `ipAllowList` CidrBlockAndDescription[], required
      - `cidrBlock` string, required
      - `description` string, required — User-provided description of the CIDR block
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `expiresAt` string, date-time — The time at which the database will be expire. Applies to free tier databases only.
    - `databaseName` string, required
    - `databaseUser` string, required
    - `environmentId` string
    - `highAvailabilityEnabled` boolean, required
    - `name` string, required
    - `owner` Owner, required
      - `id` string, required
      - `name` string, required
      - `email` string, required
      - `ipAllowList` CidrBlockAndDescription[]
        - `cidrBlock` string, required
        - `description` string, required — User-provided description of the CIDR block
      - `twoFactorAuthEnabled` boolean — Whether two-factor authentication is enabled for the owner. Only present if `type` is `user`.
      - `type` 'user' | 'team', required
    - `plan` 'free' | 'starter' | 'standard' | 'pro' | 'pro_plus' | 'custom' | 'basic_256mb' | 'basic_1gb' | 'basic_4gb' | 'pro_4gb' | 'pro_8gb' | 'pro_16gb' | 'pro_32gb' | 'pro_64gb' | 'pro_128gb' | 'pro_192gb' | 'pro_256gb' | 'pro_384gb' | 'pro_512gb' | 'accelerated_16gb' | 'accelerated_32gb' | 'accelerated_64gb' | 'accelerated_128gb' | 'accelerated_256gb' | 'accelerated_384gb' | 'accelerated_512gb' | 'accelerated_768gb' | 'accelerated_1024gb', required
    - `diskSizeGB` integer
    - `primaryPostgresID` string
    - `region` 'frankfurt' | 'oregon' | 'ohio' | 'singapore' | 'virginia', required — Defaults to "oregon"
    - `readReplicas` ReadReplica[], required
      - `id` string, required — The replica instance identifier.
      - `name` string, required — The display name of the replica instance.
      - `parameterOverrides` PostgresParameterOverrides
    - `role` 'primary' | 'replica', required
    - `status` 'creating' | 'available' | 'unavailable' | 'config_restart' | 'suspended' | 'maintenance_scheduled' | 'maintenance_in_progress' | 'recovery_failed' | 'recovery_in_progress' | 'unknown' | 'updating_instance', required
    - `version` '11' | '12' | '13' | '14' | '15' | '16' | '17' | '18', required — The PostgreSQL version
    - `suspended` 'suspended' | 'not_suspended', required
    - `suspenders` SuspenderType[], required
    - `dashboardUrl` string, required — The URL to view the Postgres instance in the Render Dashboard
    - `diskAutoscalingEnabled` boolean, required
    - `connectionPool` string, required — What connection pool to use (if any) out of 'pgbouncer' and 'none'
  - `cursor` string, required

## Other responses

- `400` — The request could not be understood by the server.
- `401` — Authorization information is missing or invalid.
- `404` — Unable to find the requested resource.
- `409` — The current state of the resource conflicts with this request.
- `429` — Rate limit has been surpassed.
- `500` — An unexpected server error has occurred.
- `503` — Server currently unavailable.

---

[API](https://skmtc.net/render/apis/render-public-api.md) · [All operations](https://skmtc.net/render/apis/render-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/render/render-public-api/versions/80e0ff74d033/schema)
