Retrieve Database Configuration

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

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationSlug

string

required

The slug of the organization or user account.

databaseName

string

required

The name of the database.

Response

200 - application/json

Successful response

size_limit

string

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

Example:

"10000"

allow_attach

boolean

deprecated

Allow or disallow attaching databases to the current database.

Example:

true

block_reads

boolean

The current status for blocked reads.

Example:

false

block_writes

boolean

The current status for blocked writes.

Example:

false

delete_protection

boolean

Prevent the database from being deleted.

Example:

true

allowed_ips

string[]

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

Example:

["203.0.113.7", "10.0.0.0/8"]

allowed_aws_vpc_ids

string[]

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

Example:

["vpce-0fe6c8807461bba49"]