Database Catalog

View as Markdown

GetGET /api/2.0/database/catalogs/{name}CreatePOST /api/2.0/database/catalogsDeleteDELETE /api/2.0/database/catalogs/{name}

DatabaseCatalog object

namestringPublic Preview

The name of the catalog in UC.

database_instance_namestringPublic Preview

The name of the DatabaseInstance housing the database.

database_namestringPublic Preview

The name of the database (in an instance) associated with the catalog.

uidstringPublic Preview

create_database_if_not_existsbooleanPublic Preview

View as Markdown

The DatabaseCatalog object

{
  "name": "string",
  "database_instance_name": "string",
  "database_name": "string",
  "uid": "string",
  "create_database_if_not_exists": true
}

Get Public Preview

GET /api/2.0/database/catalogs/{name}

Get a Database Catalog.

API scopes: postgres

Parameters

namestringpath

Response

Returns the DatabaseCatalog object.

View as Markdown

Response

{
  "name": "string",
  "database_instance_name": "string",
  "database_name": "string",
  "uid": "string",
  "create_database_if_not_exists": true
}

Create Public Preview

POST /api/2.0/database/catalogs

Create a Database Catalog.

API scopes: postgres

Request body

catalogobject

Show child attributesHide child attributes

namestring

The name of the catalog in UC.

database_instance_namestring

The name of the DatabaseInstance housing the database.

database_namestring

The name of the database (in an instance) associated with the catalog.

uidstring

create_database_if_not_existsboolean

Response

Returns the DatabaseCatalog object.

View as Markdown

Request

{
  "catalog": {
    "name": "string",
    "database_instance_name": "string",
    "database_name": "string",
    "uid": "string",
    "create_database_if_not_exists": true
  }
}

Response

{
  "name": "string",
  "database_instance_name": "string",
  "database_name": "string",
  "uid": "string",
  "create_database_if_not_exists": true
}

Delete Public Preview

DELETE /api/2.0/database/catalogs/{name}

Delete a Database Catalog.

API scopes: postgres

Parameters

namestringpath

View as Markdown

Response

{}