List PostgreSQL clusters

List all PostgreSQL clusters in the specified project and region. Results can be filtered by search query and paginated.

GET /cloud/v1/dbaas/postgres/clusters/{project_id}/{region_id}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.cloud.databases.postgres.clusters.list(
    project_id=0,
    region_id=0,
)
page = page.results[0]
print(page.cluster_name)

200

{
  "count": 1,
  "results": [
    {
      "cluster_name": "mycluster",
      "created_at": "2023-11-07T05:31:56Z",
      "version": "15"
    }
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id · integer · required

Project ID

region_id · integer · required

Region ID

Query Parameters

limit · integer · default: 10

Maximum number of clusters to return

Required range: x >= 0

name · string

Filter clusters by name

offset · integer · default: 0

Number of clusters to skip

Required range: x >= 0

Response

200 - application/json

OK

count · integer · required

Number of objects

Required range: x >= 0

Example:

1

results · PGClusterShortSerializer · object[] · required

Objects

Show child attributes