v1

latestOpenAPI 3.0.1MIT2026-07-134925112.4 KB

Retrieve Database Configuration

Retrieve an individual database configuration belonging to the organization or user.

get/v1/organizations/{organizationSlug}/databases/{databaseName}/configuration

Path parameters

organizationSlugstring required

The slug of the organization or user account.

databaseNamestring required

The name of the database.

Response

Successful response

size_limitstring

The maximum size of the database in bytes. Values with units are also accepted, e.g. 1mb, 256mb, 1gb.

allow_attachboolean

Allow or disallow attaching databases to the current database.

block_readsboolean

The current status for blocked reads.

block_writesboolean

The current status for blocked writes.

delete_protectionboolean

Prevent the database from being deleted.

allowed_ipsstring[]

List of allowed IP addresses and CIDR blocks. Empty means no IP restriction.

allowed_aws_vpc_idsstring[]

List of allowed AWS VPC endpoint IDs. Empty means no VPC endpoint restriction.

Example response

{
  "size_limit": "10000",
  "allow_attach": true,
  "delete_protection": true,
  "allowed_ips": [
    "203.0.113.7",
    "10.0.0.0/8"
  ],
  "allowed_aws_vpc_ids": [
    "vpce-0fe6c8807461bba49"
  ]
}