Skip to main content
GET
List PostgreSQL clusters

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