Skip to main content
GET
List databases

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$
status
enum<string>

STARTED and DEPLOYED: being created. RUNNING: running normally. FROZEN: stopped, for example because the balance ran out. FAILED: creation failed. CRASH_LOOP: keeps crashing on start. SUSPENDED: suspended by Liara.

Available options:
STARTED,
DEPLOYED,
RUNNING,
FROZEN,
FAILED,
CRASH_LOOP,
SUSPENDED
type
enum<string>
Available options:
mysql,
mariadb,
postgres,
mongodb,
redis,
mssql,
elasticsearch,
rabbitmq,
clickhouse
isManagedWordpress
enum<string>

Send true to list only the databases of managed WordPress sites.

Available options:
true

Response

Your databases.

databases
object[]