deleteBackupSchedule
BooleanWrapper deleteBackupSchedule(dump)
DELETE /api/2.0/backup/deletebackupschedule
Delete the backup schedule
Deletes the backup schedule of the current portal, which stops the scheduled backups; dump deletes the schedule of the whole server instead and requires the space access permission. The archives the schedule has already produced are kept and stay listed by GET api/2.0/backup/getbackuphistory - delete them through DELETE api/2.0/backup/deletebackup/{id} if they are no longer wanted. The result is always true, including when there was no schedule to delete, so it confirms that the portal now has none rather than that anything was removed. The deletion is written to the audit trail either way.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| dump | query | Boolean | Applies the operation to the whole server rather than to the current portal, which requires the space access permission and works on a standalone installation only. Server-wide backups and schedules are kept apart from the ones of a portal, so the two values address different data. | [optional] [example: false] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | True once the portal has no backup schedule, whether or not one had to be deleted | BooleanWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 402 | The portal subscription has expired or has not been paid | - | - |
| 403 | No permissions to perform this action | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 400 | Bad Request. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: Not defined
- Accept: application/json