Set the backup schedule for a database
const url = 'https://example.com/api/databases/example/schedule';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"cronExpression":"example","retentionDays":1,"enabled":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/api/databases/example/schedule \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "cronExpression": "example", "retentionDays": 1, "enabled": true }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Examplegenerated
{ "cronExpression": "example", "retentionDays": 1, "enabled": true}Responses
Section titled “Responses”Bad request — malformed input or failed validation.
object
Stable, machine-readable error code. Always present on the wire.
Human-readable error message. Always present on the wire.
Field name when the error is tied to a specific input (e.g. validation).
Optional, human-friendly hint for resolving the error.
Server-assigned request ID; quote this when reporting issues.
Example
{ "code": "READONLY_FIELD", "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.", "field": "exposedPorts", "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.", "requestId": "req_01H0…"}Unauthorized — missing or invalid bearer token.
object
Stable, machine-readable error code. Always present on the wire.
Human-readable error message. Always present on the wire.
Field name when the error is tied to a specific input (e.g. validation).
Optional, human-friendly hint for resolving the error.
Server-assigned request ID; quote this when reporting issues.
Example
{ "code": "READONLY_FIELD", "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.", "field": "exposedPorts", "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.", "requestId": "req_01H0…"}Forbidden — token scope or role does not permit this operation.
object
Stable, machine-readable error code. Always present on the wire.
Human-readable error message. Always present on the wire.
Field name when the error is tied to a specific input (e.g. validation).
Optional, human-friendly hint for resolving the error.
Server-assigned request ID; quote this when reporting issues.
Example
{ "code": "READONLY_FIELD", "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.", "field": "exposedPorts", "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.", "requestId": "req_01H0…"}Not found.
object
Stable, machine-readable error code. Always present on the wire.
Human-readable error message. Always present on the wire.
Field name when the error is tied to a specific input (e.g. validation).
Optional, human-friendly hint for resolving the error.
Server-assigned request ID; quote this when reporting issues.
Example
{ "code": "READONLY_FIELD", "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.", "field": "exposedPorts", "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.", "requestId": "req_01H0…"}