Skip to main content
GET
/
cloud
/
v1
/
dbaas
/
postgres
/
clusters
/
{project_id}
/
{region_id}
/
{cluster_name}
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
)
postgres_cluster = client.cloud.databases.postgres.clusters.get(
    cluster_name="cluster_name",
    project_id=0,
    region_id=0,
)
print(postgres_cluster.cluster_name)
{
  "cluster_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "databases": [
    {
      "name": "mydatabase",
      "owner": "myuser",
      "size": 2048
    }
  ],
  "flavor": {
    "cpu": 1,
    "memory_gib": 1
  },
  "high_availability": {},
  "network": {
    "acl": [
      "92.33.34.127"
    ],
    "connection_string": "postgresql://username:password@address.example.com:5432/dbname",
    "host": "address.example.com",
    "network_type": "public"
  },
  "pg_server_configuration": {
    "pg_conf": "\nlisten_addresses = 'localhost'\nport = 5432\nmax_connections = 100\nshared_buffers = 128MB\nlogging_collector = on",
    "version": "<string>",
    "pooler": null
  },
  "storage": {
    "size_gib": 100,
    "type": "ssd-hiiops"
  },
  "users": [
    {
      "is_secret_revealed": true,
      "name": "myuser",
      "role_attributes": [
        "INHERIT"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://gcore-doc-1046.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

​
cluster_name
string
required

Cluster name

Response

200 - application/json

OK

​
cluster_name
string
required
Required string length: 1 - 50
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
​
created_at
string<date-time>
required
​
databases
DatabaseOverview · object[]
required
​
flavor
Flavor · object
required

Instance RAM and CPU

​
high_availability
HighAvailabilityOptions · object
required
​
network
Network · object
required
​
pg_server_configuration
PostgreSQLServerConfig · object
required

Main PG configuration

​
status
enum<string>
required

Current cluster status

Available options:
DELETING,
FAILED,
PREPARING,
READY,
UNHEALTHY,
UNKNOWN,
UPDATING
​
storage
Storage · object
required

PG's storage configuration

​
users
PgUserOverview · object[]
required