Roles and permissions are now available. Give team members granular permissions. View the docs →
curl --request POST \
--url https://cloud.laravel.com/api/databases/clusters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": {
"suspend_seconds": 123,
"retention_days": 123
},
"cluster_id": 123
}
'{
"data": {
"id": "<string>",
"attributes": {
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"config": {
"suspend_seconds": 123,
"retention_days": 123
},
"connection": {
"hostname": "<string>",
"username": "<string>",
"password": "<string>"
}
},
"relationships": {
"schemas": {
"data": [
{
"id": "<string>"
}
]
},
"databases": {
"data": [
{
"id": "<string>"
}
]
}
}
},
"included": [
{
"id": "<string>",
"attributes": {
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"database": {
"data": {
"id": "<string>"
}
},
"environments": {
"data": [
{
"id": "<string>"
}
]
}
}
}
]
}Create a new database cluster. A default database will also be created and returned on the databases relationship. schemas is deprecated.
curl --request POST \
--url https://cloud.laravel.com/api/databases/clusters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": {
"suspend_seconds": 123,
"retention_days": 123
},
"cluster_id": 123
}
'{
"data": {
"id": "<string>",
"attributes": {
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"config": {
"suspend_seconds": 123,
"retention_days": 123
},
"connection": {
"hostname": "<string>",
"username": "<string>",
"password": "<string>"
}
},
"relationships": {
"schemas": {
"data": [
{
"id": "<string>"
}
]
},
"databases": {
"data": [
{
"id": "<string>"
}
]
}
}
},
"included": [
{
"id": "<string>",
"attributes": {
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"database": {
"data": {
"id": "<string>"
}
},
"environments": {
"data": [
{
"id": "<string>"
}
]
}
}
}
]
}Documentation Index
Fetch the complete documentation index at: https://cloud.laravel.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
The Bearer Token generated on the Cloud UI.
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 3 - 40^[a-z0-9_-]+$us-east-2, us-east-1, ca-central-1, eu-central-1, eu-west-1, eu-west-2, me-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1 Configuration object. Fields vary based on database type.
Show child attributes
Was this page helpful?