List database clusters

Get a list of all database clusters for the authenticated organization. The schemas relationship is deprecated.

GET /databases/clusters

List database clusters

cURL

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

200

{
  "data": [
    {
      "id": "<string>",
      "type": "databases",
      "attributes": {
        "name": "<string>",
        "type": "laravel_mysql_84",
        "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": 3306,
          "protocol": "mysql",
          "driver": "mysql",
          "username": "<string>",
          "password": "<string>"
        }
      },
      "relationships": {
        "schemas": {
          "data": [
            {
              "type": "databaseSchemas",
              "id": "<string>"
            }
          ]
        },
        "databases": {
          "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>"
          }
        },
        "environments": {
          "data": [
            {
              "type": "environments",
              "id": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

The Bearer Token generated on the Cloud UI.

Query Parameters

include · string

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

filter[type] · string

filter[region] · string

filter[status] · string

Response

200

application/vnd.api+json

Paginated set of DatabaseResource

data · DatabaseResource · object[] · required

Show child attributes

links · object · required

Show child attributes

meta · object · required

Show child attributes

included · DatabaseSchemaResource · object[]

Show child attributes