Skip to main content
POST
/
databases
/
clusters
Create database cluster
curl --request POST \
  --url https://cloud.laravel.com/api/databases/clusters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "laravel_mysql_84",
  "name": "<string>",
  "region": "us-east-2",
  "config": {
    "cu_min": 0.25,
    "cu_max": 0.25,
    "suspend_seconds": 123,
    "retention_days": 123
  },
  "cluster_id": 123
}
'
{
  "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>"
          }
        ]
      }
    }
  },
  "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.

Body

application/json
​
type
enum<string>
required
Available options:
laravel_mysql_84,
laravel_mysql_8,
aws_rds_mysql_8,
aws_rds_postgres_18,
neon_serverless_postgres_18,
neon_serverless_postgres_17,
neon_serverless_postgres_16
​
name
string
required
Required string length: 3 - 40
Pattern: ^[a-z0-9_-]+$
​
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,
me-central-1
​
config
Neon Serverless Postgres · object
required

Configuration object. Fields vary based on database type.

​
cluster_id
integer | null

Response

DatabaseResource

​
data
DatabaseResource · object
required
​
included
DatabaseSchemaResource · object[]