Backup Schedules

List instance backup schedules

get/instances/{instanceId}/backup-schedules

Request

Base URL: https://api.cloudpepper.io
URL: https://api.cloudpepper.io/instances/{instanceId}/backup-schedules
Auth: HTTP bearer

Response

Backups schedules retrieved successfully

idstring

instanceIdstring uuid

Instance ID

schedulestring

Cron expression defining when the backup should run. Format: 'minute hour day-of-month month day-of-week'.

Supported special values:

@monthly: Run once a month, first day at midnight ('00 00 1 * *')
@weekly: Run once a week, Sunday at midnight ('00 00 * * 0')
@daily, @midnight: Run once a day at midnight ('00 00 * * *')
@hourly: Run once an hour at the start of the hour ('00 * * * *')

Supported interval patterns:

'00 */12 * * *': Run every 12 hours
'00 */6 * * *': Run every 6 hours
'00 */3 * * *': Run every 3 hours

Standard cron examples:

'00 08 * * *': Run daily at 8:00 AM (UTC)
'00 20 * * *': Run daily at 8:00 PM (UTC)
'00 00 1 * *': Run at midnight on the first day of each month
'00 00 * * 0': Run at midnight on Sunday

retentioninteger

Number of days to retain the backup. Common values: 7 (one week), 30 (one month), 90 (three months), 365 (one year).

providerIdstring uuid

Optional ID of a specific backup provider to use. If not specified, the default provider will be used.

Example response

[
  {
    "id": "-Nn9lptXLlXX7jCXcQo4",
    "instanceId": "00000000-0000-0000-0000-000000000000",
    "schedule": "00 08 * * *",
    "retention": 31,
    "providerId": "550e8400-e29b-41d4-a716-446655440000"
  }
]

Changes

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