Skip to main content

Database API

Provision and manage PostgreSQL databases on demand.

Provision a Database​

POST /api/databases

Requires: Authorization: Bearer YOUR_JWT_TOKEN

Creates a new PostgreSQL database instance for your account.

Response​

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "databaseName": "client_550e8400_a1b2c3d4",
  "host": "intelligence.cognitera.ai",
  "port": 5432,
  "username": "user_a1b2c3d4e5f6",
  "password": "generated-secure-password",
  "connectionString": "postgresql://user_a1b2c3d4e5f6:generated-secure-password@intelligence.cognitera.ai:5432/client_550e8400_a1b2c3d4"
}
tip

Save the connection string — the password is only shown once at creation time.

List Databases​

GET /api/databases

Requires: Authorization: Bearer YOUR_JWT_TOKEN

Returns all active databases for your account.

Get Database Details​

GET /api/databases/:id

Requires: Authorization: Bearer YOUR_JWT_TOKEN

Response​

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "databaseName": "client_550e8400_a1b2c3d4",
  "host": "intelligence.cognitera.ai",
  "port": 5432,
  "username": "user_a1b2c3d4e5f6",
  "storageMb": 42.5,
  "maxStorageMb": 1024,
  "createdAt": "2026-03-19T12:00:00Z"
}

Destroy a Database​

DELETE /api/databases/:id

Requires: Authorization: Bearer YOUR_JWT_TOKEN

danger

This action is irreversible. All data in the database will be permanently deleted.

Response​

{
  "message": "Database destroyed successfully"
}