Databases

Lists your databases, newest first. With teamID, it lists the team's databases you have access to.

get/v1/databases

Request

  • Base URL
    https://api.liara.ir
  • URL
    https://api.liara.ir/v1/databases
  • Auth
    HTTP bearer

Query parameters

teamIDstring

24-character hexadecimal ID.

Run the request in the context of a team you belong to, instead of your personal account.

status'STARTED' | 'DEPLOYED' | 'RUNNING' | 'FROZEN' | 'FAILED' | 'CRASH_LOOP' | 'SUSPENDED'

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.

type'mysql' | 'mariadb' | 'postgres' | 'mongodb' | 'redis' | 'mssql' | 'elasticsearch' | 'rabbitmq' | 'clickhouse'
isManagedWordpress'true'

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

Response

Your databases.

Changes

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new CRASH_LOOP enum value to the // response property for the response status

    • warning

      added the new DEPLOYED enum value to the // response property for the response status

    • warning

      added the new FAILED enum value to the // response property for the response status

    • warning

      added the new FROZEN enum value to the // response property for the response status

    • warning

      added the new RUNNING enum value to the // response property for the response status

    • warning

      added the new STARTED enum value to the // response property for the response status

    • warning

      added the new SUSPENDED enum value to the // response property for the response status

    • warning

      added the new clickhouse enum value to the // response property for the response status

    • warning

      added the new elasticsearch enum value to the // response property for the response status

    • warning

      added the new mariadb enum value to the // response property for the response status

    • warning

      added the new mongodb enum value to the // response property for the response status

    • warning

      added the new mssql enum value to the // response property for the response status

    • warning

      added the new mysql enum value to the // response property for the response status

    • warning

      added the new postgres enum value to the // response property for the response status

    • warning

      added the new rabbitmq enum value to the // response property for the response status

    • warning

      added the new redis enum value to the // response property for the response status

    • info

      api operation id getListDatabases removed and replaced with listDatabases

    • info

      added the new optional query request parameter isManagedWordpress

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter teamID

    • info

      added the new optional query request parameter type

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • breaking

      removed the media type Databaselication/json for the response with the status

    • info

      added the media type application/json for the response with the status