Backup Schedule
This endpoint is deprecated since 2025.05 and will be removed in the future. Please use GET /consoleExportSchedule
Responses
default
default response
application/json
createdDatestring · date-timeOptional
cronExpressionstringOptional
descriptionstringOptional
environmentIdstring · uuidOptional
frequencyWarningstringOptional
idstring · uuidOptional
maxRetainedinteger · int32Optional
modifiedDatestring · date-timeOptional
namestringOptional
nextExecutionstring · date-timeOptional
numberOfBackupsinteger · int32Optional
retentionDaysinteger · enumOptionalPossible values:
get/backupSchedule
GET /rest/backupSchedule HTTP/1.1
Accept: */*
default
default response
[
{
"createdDate": "2026-01-01T00:00:00.000Z",
"cronExpression": "text",
"description": "text",
"dgcBackupOptions": [
"CONFIGURATION"
],
"environmentId": "123e4567-e89b-12d3-a456-426614174000",
"frequencyWarning": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"maxRetained": 1,
"modifiedDate": "2026-01-01T00:00:00.000Z",
"name": "text",
"nextExecution": "2026-01-01T00:00:00.000Z",
"numberOfBackups": 1,
"repoBackupOptions": [
"DATA"
],
"retentionDays": 7,
"serverTimeZoneOffset": {
"id": "text",
"rules": {
"fixedOffset": true,
"transitionRules": [
{
"dayOfMonthIndicator": 1,
"dayOfWeek": "MONDAY",
"localTime": {
"hour": 1,
"minute": 1,
"nano": 1,
"second": 1
},
"midnightEndOfDay": true,
"month": "JANUARY",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"standardOffset": {
"id": "text",
"totalSeconds": 1
},
"timeDefinition": "UTC"
}
],
"transitions": [
{
"dateTimeAfter": "2026-01-01T00:00:00.000Z",
"dateTimeBefore": "2026-01-01T00:00:00.000Z",
"duration": {
"nano": 1,
"negative": true,
"positive": true,
"seconds": 1,
"units": [
{
"dateBased": true,
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
},
"gap": true,
"instant": "2026-01-01T00:00:00.000Z",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"overlap": true
}
]
},
"totalSeconds": 1
}
}
]This endpoint is deprecated since 2025.05 and will be removed in the future. Please use POST /consoleExportSchedule
Body
cronExpressionstringOptional
descriptionstringOptional
environmentIdstring · uuidOptional
maxRetainedinteger · int32Optional
namestringOptional
retentionDaysinteger · enumOptionalPossible values:
Responses
201
successful operation
application/json
createdDatestring · date-timeOptional
cronExpressionstringOptional
descriptionstringOptional
environmentIdstring · uuidOptional
frequencyWarningstringOptional
idstring · uuidOptional
maxRetainedinteger · int32Optional
modifiedDatestring · date-timeOptional
namestringOptional
nextExecutionstring · date-timeOptional
numberOfBackupsinteger · int32Optional
retentionDaysinteger · enumOptionalPossible values:
post/backupSchedule
POST /rest/backupSchedule HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 215
{
"cronExpression": "text",
"description": "text",
"dgcBackupOptions": [
"CONFIGURATION"
],
"environmentId": "123e4567-e89b-12d3-a456-426614174000",
"maxRetained": 1,
"name": "text",
"repoBackupOptions": [
"DATA"
],
"retentionDays": 7
}201
successful operation
{
"createdDate": "2026-01-01T00:00:00.000Z",
"cronExpression": "text",
"description": "text",
"dgcBackupOptions": [
"CONFIGURATION"
],
"environmentId": "123e4567-e89b-12d3-a456-426614174000",
"frequencyWarning": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"maxRetained": 1,
"modifiedDate": "2026-01-01T00:00:00.000Z",
"name": "text",
"nextExecution": "2026-01-01T00:00:00.000Z",
"numberOfBackups": 1,
"repoBackupOptions": [
"DATA"
],
"retentionDays": 7,
"serverTimeZoneOffset": {
"id": "text",
"rules": {
"fixedOffset": true,
"transitionRules": [
{
"dayOfMonthIndicator": 1,
"dayOfWeek": "MONDAY",
"localTime": {
"hour": 1,
"minute": 1,
"nano": 1,
"second": 1
},
"midnightEndOfDay": true,
"month": "JANUARY",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"standardOffset": {
"id": "text",
"totalSeconds": 1
},
"timeDefinition": "UTC"
}
],
"transitions": [
{
"dateTimeAfter": "2026-01-01T00:00:00.000Z",
"dateTimeBefore": "2026-01-01T00:00:00.000Z",
"duration": {
"nano": 1,
"negative": true,
"positive": true,
"seconds": 1,
"units": [
{
"dateBased": true,
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
},
"gap": true,
"instant": "2026-01-01T00:00:00.000Z",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"overlap": true
}
]
},
"totalSeconds": 1
}
}This endpoint is deprecated since 2025.05 and will be removed in the future. Please use GET /consoleExportSchedule/environment/{environmentId}
Path parameters
environmentIdstring · uuidRequired
The id of the environment
Responses
200
List of backup schedules for the given environment
application/json
createdDatestring · date-timeOptional
cronExpressionstringOptional
descriptionstringOptional
environmentIdstring · uuidOptional
frequencyWarningstringOptional
idstring · uuidOptional
maxRetainedinteger · int32Optional
modifiedDatestring · date-timeOptional
namestringOptional
nextExecutionstring · date-timeOptional
numberOfBackupsinteger · int32Optional
retentionDaysinteger · enumOptionalPossible values:
204
No backup schedules for the given environment
404
Environment could not be found
get/backupSchedule/environment/{environmentId}
GET /rest/backupSchedule/environment/{environmentId} HTTP/1.1
Accept: */*
[
{
"createdDate": "2026-01-01T00:00:00.000Z",
"cronExpression": "text",
"description": "text",
"dgcBackupOptions": [
"CONFIGURATION"
],
"environmentId": "123e4567-e89b-12d3-a456-426614174000",
"frequencyWarning": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"maxRetained": 1,
"modifiedDate": "2026-01-01T00:00:00.000Z",
"name": "text",
"nextExecution": "2026-01-01T00:00:00.000Z",
"numberOfBackups": 1,
"repoBackupOptions": [
"DATA"
],
"retentionDays": 7,
"serverTimeZoneOffset": {
"id": "text",
"rules": {
"fixedOffset": true,
"transitionRules": [
{
"dayOfMonthIndicator": 1,
"dayOfWeek": "MONDAY",
"localTime": {
"hour": 1,
"minute": 1,
"nano": 1,
"second": 1
},
"midnightEndOfDay": true,
"month": "JANUARY",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"standardOffset": {
"id": "text",
"totalSeconds": 1
},
"timeDefinition": "UTC"
}
],
"transitions": [
{
"dateTimeAfter": "2026-01-01T00:00:00.000Z",
"dateTimeBefore": "2026-01-01T00:00:00.000Z",
"duration": {
"nano": 1,
"negative": true,
"positive": true,
"seconds": 1,
"units": [
{
"dateBased": true,
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
},
"gap": true,
"instant": "2026-01-01T00:00:00.000Z",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"overlap": true
}
]
},
"totalSeconds": 1
}
}
]This endpoint is deprecated since 2025.05 and will be removed in the future. Please use GET /consoleExportSchedule/{id}
Path parameters
idstring · uuidRequired
The id of the schedule
Responses
default
default response
application/json
createdDatestring · date-timeOptional
cronExpressionstringOptional
descriptionstringOptional
environmentIdstring · uuidOptional
frequencyWarningstringOptional
idstring · uuidOptional
maxRetainedinteger · int32Optional
modifiedDatestring · date-timeOptional
namestringOptional
nextExecutionstring · date-timeOptional
numberOfBackupsinteger · int32Optional
retentionDaysinteger · enumOptionalPossible values:
get/backupSchedule/{id}
GET /rest/backupSchedule/{id} HTTP/1.1
Accept: */*
default
default response
{
"createdDate": "2026-01-01T00:00:00.000Z",
"cronExpression": "text",
"description": "text",
"dgcBackupOptions": [
"CONFIGURATION"
],
"environmentId": "123e4567-e89b-12d3-a456-426614174000",
"frequencyWarning": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"maxRetained": 1,
"modifiedDate": "2026-01-01T00:00:00.000Z",
"name": "text",
"nextExecution": "2026-01-01T00:00:00.000Z",
"numberOfBackups": 1,
"repoBackupOptions": [
"DATA"
],
"retentionDays": 7,
"serverTimeZoneOffset": {
"id": "text",
"rules": {
"fixedOffset": true,
"transitionRules": [
{
"dayOfMonthIndicator": 1,
"dayOfWeek": "MONDAY",
"localTime": {
"hour": 1,
"minute": 1,
"nano": 1,
"second": 1
},
"midnightEndOfDay": true,
"month": "JANUARY",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"standardOffset": {
"id": "text",
"totalSeconds": 1
},
"timeDefinition": "UTC"
}
],
"transitions": [
{
"dateTimeAfter": "2026-01-01T00:00:00.000Z",
"dateTimeBefore": "2026-01-01T00:00:00.000Z",
"duration": {
"nano": 1,
"negative": true,
"positive": true,
"seconds": 1,
"units": [
{
"dateBased": true,
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
},
"gap": true,
"instant": "2026-01-01T00:00:00.000Z",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"overlap": true
}
]
},
"totalSeconds": 1
}
}This endpoint is deprecated since 2025.05 and will be removed in the future. Please use PUT /consoleExportSchedule/{id}
Path parameters
idstring · uuidRequired
The id of the schedule to update
Body
backupScheduleIdstring · uuidOptional
cronExpressionstringOptional
descriptionstringOptional
maxRetainedinteger · int32Optional
namestringOptional
retentionDaysinteger · enumOptionalPossible values:
Responses
default
default response
application/json
createdDatestring · date-timeOptional
cronExpressionstringOptional
descriptionstringOptional
environmentIdstring · uuidOptional
frequencyWarningstringOptional
idstring · uuidOptional
maxRetainedinteger · int32Optional
modifiedDatestring · date-timeOptional
namestringOptional
nextExecutionstring · date-timeOptional
numberOfBackupsinteger · int32Optional
retentionDaysinteger · enumOptionalPossible values:
put/backupSchedule/{id}
PUT /rest/backupSchedule/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 218
{
"backupScheduleId": "123e4567-e89b-12d3-a456-426614174000",
"cronExpression": "text",
"description": "text",
"dgcBackupOptions": [
"CONFIGURATION"
],
"maxRetained": 1,
"name": "text",
"repoBackupOptions": [
"DATA"
],
"retentionDays": 7
}default
default response
{
"createdDate": "2026-01-01T00:00:00.000Z",
"cronExpression": "text",
"description": "text",
"dgcBackupOptions": [
"CONFIGURATION"
],
"environmentId": "123e4567-e89b-12d3-a456-426614174000",
"frequencyWarning": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"maxRetained": 1,
"modifiedDate": "2026-01-01T00:00:00.000Z",
"name": "text",
"nextExecution": "2026-01-01T00:00:00.000Z",
"numberOfBackups": 1,
"repoBackupOptions": [
"DATA"
],
"retentionDays": 7,
"serverTimeZoneOffset": {
"id": "text",
"rules": {
"fixedOffset": true,
"transitionRules": [
{
"dayOfMonthIndicator": 1,
"dayOfWeek": "MONDAY",
"localTime": {
"hour": 1,
"minute": 1,
"nano": 1,
"second": 1
},
"midnightEndOfDay": true,
"month": "JANUARY",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"standardOffset": {
"id": "text",
"totalSeconds": 1
},
"timeDefinition": "UTC"
}
],
"transitions": [
{
"dateTimeAfter": "2026-01-01T00:00:00.000Z",
"dateTimeBefore": "2026-01-01T00:00:00.000Z",
"duration": {
"nano": 1,
"negative": true,
"positive": true,
"seconds": 1,
"units": [
{
"dateBased": true,
"durationEstimated": true,
"timeBased": true
}
],
"zero": true
},
"gap": true,
"instant": "2026-01-01T00:00:00.000Z",
"offsetAfter": {
"id": "text",
"totalSeconds": 1
},
"offsetBefore": {
"id": "text",
"totalSeconds": 1
},
"overlap": true
}
]
},
"totalSeconds": 1
}
}This endpoint is deprecated since 2025.05 and will be removed in the future. Please use DELETE /consoleExportSchedule/{id}
Path parameters
idstring · uuidRequired
The id of the schedule to delete
Responses
204
successful operation
No content
delete/backupSchedule/{id}
DELETE /rest/backupSchedule/{id} HTTP/1.1
Accept: */*
204
successful operation
No content
This endpoint is deprecated since 2025.05 and will be removed in the future. Please use GET /consoleExportSchedule/{id}/consoleExports
Path parameters
idstring · uuidRequired
The id of the schedule
Responses
default
default response
application/json
createdDatestring · date-timeOptional
idstring · uuidOptional
inProgressbooleanOptional
keystringOptional
modifiedDatestring · date-timeOptional
sizeinteger · int64Optional
get/backupSchedule/{id}/backups
GET /rest/backupSchedule/{id}/backups HTTP/1.1
Accept: */*
default
default response
[
{
"backupInformation": {
"appVersion": "text",
"backupSpecificationId": "123e4567-e89b-12d3-a456-426614174000",
"createdByEmail": "text",
"date": "2026-01-01T00:00:00.000Z",
"description": "text",
"dgcBackupOptions": [
"CUSTOMIZATIONS",
"CONFIGURATION"
],
"environmentId": "123e4567-e89b-12d3-a456-426614174000",
"expirationDate": "2026-01-01T00:00:00.000Z",
"name": "text",
"repoBackupOptions": [
"DATA",
"HISTORY"
],
"retentionDays": 1
},
"createdDate": "2026-01-01T00:00:00.000Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"inProgress": true,
"key": "text",
"modifiedDate": "2026-01-01T00:00:00.000Z",
"size": 1,
"stepStateMap": {
"ANY_ADDITIONAL_PROPERTY": {
"errorMessage": "text",
"status": "UNKNOWN"
}
}
}
]Last updated
Was this helpful?