List database clusters

curl --request GET \
  --url https://app.laravel.cloud/api/databases \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "databases",
      "attributes": {
        "name": "<string>",
        "type": "laravel_mysql_8",
        "status": "creating",
        "region": "us-east-2",
        "created_at": "2023-11-07T05:31:56Z",
        "config": {
          "cu_min": 0.25,
          "cu_max": 0.25,
          "suspend_seconds": 123,
          "retention_days": 123
        },
        "connection": {
          "hostname": "<string>",
          "port": 123,
          "protocol": "<string>",
          "driver": "<string>",
          "username": "<string>",
          "password": "<string>"
        }
      },
      "relationships": {
        "schemas": {
          "data": [
            {
              "type": "databaseSchemas",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  },
  "included": [
    {
      "id": "<string>",
      "type": "databaseSchemas",
      "attributes": {
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "database": {
          "data": {
            "type": "databases",
            "id": "<string>"
          }
        }
      }
    }
  ]
}

GET

databases

curl --request GET \
  --url https://app.laravel.cloud/api/databases \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "databases",
      "attributes": {
        "name": "<string>",
        "type": "laravel_mysql_8",
        "status": "creating",
        "region": "us-east-2",
        "created_at": "2023-11-07T05:31:56Z",
        "config": {
          "cu_min": 0.25,
          "cu_max": 0.25,
          "suspend_seconds": 123,
          "retention_days": 123
        },
        "connection": {
          "hostname": "<string>",
          "port": 123,
          "protocol": "<string>",
          "driver": "<string>",
          "username": "<string>",
          "password": "<string>"
        }
      },
      "relationships": {
        "schemas": {
          "data": [
            {
              "type": "databaseSchemas",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  },
  "included": [
    {
      "id": "<string>",
      "type": "databaseSchemas",
      "attributes": {
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "database": {
          "data": {
            "type": "databases",
            "id": "<string>"
          }
        }
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

The Bearer Token generated on the Cloud UI.

Query Parameters

include

string

Available includes are schemas. You can include multiple options by separating them with a comma.

filter[type]

string

filter[region]

string

filter[status]

string

Response

Paginated set of DatabaseResource

data

DatabaseResource · object[]

required

Show child attributes

data.id

string

required

data.type

enum<string>

required

Available options:

databases

data.attributes

object

Show child attributes

data.attributes.name

string

required

data.attributes.type

enum<string>

required

Available options:

laravel_mysql_8,

aws_rds_mysql_8,

neon_serverless_postgres_18,

neon_serverless_postgres_17,

neon_serverless_postgres_16

data.attributes.status

enum<string>

required

Available options:

creating,

updating,

restarting,

upgrading,

available,

restoring,

restore_failed,

disabled,

snapshotting_before_archiving,

archiving,

archived,

deleting,

deleted,

unknown

data.attributes.region

enum<string>

required

Available options:

us-east-2,

us-east-1,

eu-central-1,

eu-west-1,

eu-west-2,

ap-southeast-1,

ap-southeast-2,

ca-central-1

data.attributes.created_at

string<date-time> | null

required

data.attributes.config

object

required

Configuration object. Fields vary based on database type.

Option 1
Option 2
Option 3

Show child attributes

data.attributes.config.cu_min

enum<number>

required

Minimum compute units for auto-scaling

Available options:

0.25,

0.5,

1,

2,

4,

8,

10

data.attributes.config.cu_max

enum<number>

required

Maximum compute units for auto-scaling

Available options:

0.25,

0.5,

1,

2,

4,

8,

10

data.attributes.config.suspend_seconds

integer

required

Seconds of inactivity before hibernation (0 = never) (min: 0, max: 604800)

data.attributes.config.retention_days

integer

required

Days to retain point-in-time recovery data (min: 0, max: 30)

data.attributes.connection

object

required

Show child attributes

data.attributes.connection.hostname

string

required

data.attributes.connection.port

integer

required

data.attributes.connection.protocol

string

required

data.attributes.connection.driver

string

required

data.attributes.connection.username

string

required

data.attributes.connection.password

string

required

data.relationships

object

Show child attributes

data.relationships.schemas

object

Show child attributes

data.relationships.schemas.data

DatabaseSchemaResourceIdentifier · object[]

required

Show child attributes

data.relationships.schemas.data.type

enum<string>

required

Available options:

databaseSchemas

data.relationships.schemas.data.id

string

required

links

object

required

Show child attributes

links.first

string

links.last

string

links.prev

string

links.next

string

Overview

Endpoints

List database clusters

Authorizations

Query Parameters

Response