Backups

Create backup configuration

Create a new backup configuration for the server.

Processing mode: <small><code>async</code></small>

post/orgs/{organization}/servers/{server}/database/backups

Request

Base URL
https://forge.laravel.com/api
Auth
OAuth 2
Authorization codehttps://forge.laravel.com/oauth/authorize
Token URLhttps://forge.laravel.com/oauth/token
Scopesserver:create-backups
TypeScript
https://skmtc.dev/mfullbrook/apis/forge/docs/orgs/:organization/servers/:server/database/backups/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

The organization slug

serverinteger required

The server ID

Request body

storage_provider_idinteger required

namestring nullable

bucketstring nullable

directorystring nullable

frequency'hourly' | 'daily' | 'weekly' | 'custom' required

day'0' | '1' | '2' | '3' | '4' | '5' | '6'

time'00:00' | '00:30' | '01:00' | '01:30' | '02:00' | '02:30' | '03:00' | '03:30' | '04:00' | '04:30' | '05:00' | '05:30' | '06:00' | '06:30' | '07:00' | '07:30' | '08:00' | '08:30' | '09:00' | '09:30' | '10:00' | '10:30' | '11:00' | '11:30' | '12:00' | '12:30' | '13:00' | '13:30' | '14:00' | '14:30' | '15:00' | '15:30' | '16:00' | '16:30' | '17:00' | '17:30' | '18:00' | '18:30' | '19:00' | '19:30' | '20:00' | '20:30' | '21:00' | '21:30' | '22:00' | '22:30' | '23:00' | '23:30'

cronstring

retentioninteger required

notification_emailstring email nullable

database_idsinteger[] required

Changes

No recorded changes to this operation across all 1 revision of this API.