Get the backup schedule

GET /api/2.0/backup/getbackupschedule

Request

Returns the backup schedule of the current portal.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Examples

GET /api/2.0/backup/getbackupschedule HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/backup/getbackupschedule \
  --header 'Accept: application/json'

Responses

200

Backup schedule

storageTypeone of

.enum of string

[Documents - Documents, ThridpartyDocuments - Thridparty documents, CustomCloud - Custom cloud, Local - Local, DataStore - Data store, ThirdPartyConsumer - Thirdparty consumer]

Can be one of: Documents, ThridpartyDocuments, CustomCloud, Local, DataStore, ThirdPartyConsumer.

.enum of integer

[0 - Documents, 1 - Thridparty documents, 2 - Custom cloud, 3 - Local, 4 - Data store, 5 - Thirdparty consumer]

Can be one of: 0, 1, 2, 3, 4, 5.

storageParamsobject

cronParamsobject

periodone of

.enum of string

[EveryDay - Every day, EveryWeek - Every week, EveryMonth - Every month]

Can be one of: EveryDay, EveryWeek, EveryMonth.

.enum of integer

[0 - Every day, 1 - Every week, 2 - Every month]

Can be one of: 0, 1, 2.

hourintegerformat: int32

dayintegerformat: int32

backupsStoredintegerformat: int32

lastBackupTimestringformat: date-time

dumpboolean

401

Unauthorized

402

Your pricing plan does not support this option