Contact UsGet started

Managed Service for PostgreSQL API, REST: Database.Get

Written by
Updated at November 26, 2024

Returns the specified PostgreSQL Database resource.

To get the list of available PostgreSQL Database resources, make a List request.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/databases/{databaseName}

Path parameters

Field

Description

clusterId

string

Required field. ID of the PostgreSQL cluster that the database belongs to.
To get the cluster ID use a ClusterService.List request.

databaseName

string

Required field. Name of the PostgreSQL Database resource to return.
To get the name of the database use a DatabaseService.List request.

Response

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string",
  "owner": "string",
  "lcCollate": "string",
  "lcCtype": "string",
  "extensions": [
    {
      "name": "string",
      "version": "string"
    }
  ],
  "templateDb": "string",
  "deletionProtection": "boolean"
}

A PostgreSQL Database resource. For more information, see
the Developer's Guide.

Field

Description

name

string

Name of the database.

clusterId

string

ID of the PostgreSQL cluster that the database belongs to.

owner

string

Name of the user assigned as the owner of the database.

lcCollate

string

POSIX locale for string sorting order.
Can only be set at creation time.

lcCtype

string

POSIX locale for character classification.
Can only be set at creation time.

extensions[]

Extension

PostgreSQL extensions enabled for the database.

templateDb

string

Name of the database template.

deletionProtection

boolean

Deletion Protection inhibits deletion of the database

Default value: unspecified (inherits cluster's deletion_protection)

Extension

Field

Description

name

string

Name of the extension, e.g. pg_trgm or pg_btree.
Extensions supported by Managed Service for PostgreSQL are listed in the Developer's Guide.

version

string

Version of the extension.
Previous
Overview
Next
List