Postgres version
Information related to Postgres versions which are available for use on Crunchy Bridge.
Part of the API reference collection
This page is part of the Crunchy Bridge API reference, and primarily meant to act as an exhaustive guide for technical integrations which are already in progress. To understand the basics of using the API, see API concepts and getting started.
List Postgres versions
List available Postgres versions.
GET /postgres-versions
Request
Query parameters
Name | Required | Type | Description |
---|---|---|---|
team_id | string | Optional team ID that can be passed and which may provide additional access to generally unavailable Postgres versions if the team is appropriately flagged. |
cURL example
curl -X GET https://api.crunchybridge.com/postgres-versions
-H "Authorization: Bearer $CRUNCHY_API_KEY"
Response
Status: 200
Response of a request to list Postgres versions.
Content type: application/json
Name | Nullable | Type | Description |
---|---|---|---|
postgres_versions | array of array | Supported Postgres versions. |
Example
{
"postgres_versions": [
{
"display_name": "Postgres 13",
"id": "6ibnzig5avgutdgdzei2jwvvt4",
"is_default": true,
"major_version": 13
}
]
}
Get Postgres version
Get a specific Postgres version.
GET /postgres-versions/{postgres_version_id}
Request
Path parameters
postgres_version_id
: An identifier for the Postgres version to retrieve. May be either the primary ID of a Postgres version or a major version number like "14".
Query parameters
Name | Required | Type | Description |
---|---|---|---|
team_id | string | Optional team ID that can be passed and which may provide additional access to generally unavailable Postgres versions if the team is appropriately flagged. |
cURL example
curl -X GET https://api.crunchybridge.com/postgres-versions/{postgres_version_id}
-H "Authorization: Bearer $CRUNCHY_API_KEY"
Response
Status: 200
PostgresVersion contains information about a supported PostgreSQL version.
Content type: application/json
Name | Nullable | Type | Description |
---|---|---|---|
id | string in EID format | Unique ID for the Postgres version. | |
display_name | string | A user-facing name for the Postgres version like | |
is_default | boolean | Whether this is the default Postgres version for newly created clusters. | |
major_version | integer | The Postgres major version like |
Example
{
"display_name": "Postgres 13",
"id": "6ibnzig5avgutdgdzei2jwvvt4",
"is_default": true,
"major_version": 13
}