Update database cluster
curl --request PATCH \
--url https://cloud.laravel.com/api/databases/clusters/{database} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"suspend_seconds": 123,
"retention_days": 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>"
}
]
}
}
}
]
}Database Clusters
Update database cluster
Update a database cluster.
PATCH
/
databases
/
clusters
/
{database}
Update database cluster
curl --request PATCH \
--url https://cloud.laravel.com/api/databases/clusters/{database} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"suspend_seconds": 123,
"retention_days": 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>"
}
]
}
}
}
]
}Authorizations
The Bearer Token generated on the Cloud UI.
Path Parameters
The database identifier
Body
application/json
Configuration object. Fields vary based on database type.
- Neon Serverless Postgres
- Laravel MySQL
- AWS RDS
Show child attributes
Show child attributes
Was this page helpful?
⌘I

