Backup Schedule

Deprecated

Retrieve all backup schedules

get

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

HTTPcURLJavaScriptPython

GET /rest/backupSchedule HTTP/1.1
Accept: */*

default

default response

[
  {
    "createdDate": "2026-07-12T01:05:03.365Z",
    "cronExpression": "text",
    "description": "text",
    "dgcBackupOptions": [
      "CONFIGURATION"
    ],
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "frequencyWarning": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "maxRetained": 1,
    "modifiedDate": "2026-07-12T01:05:03.365Z",
    "name": "text",
    "nextExecution": "2026-07-12T01:05:03.365Z",
    "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-07-12T01:05:03.365Z",
            "dateTimeBefore": "2026-07-12T01:05:03.365Z",
            "duration": {
              "nano": 1,
              "negative": true,
              "positive": true,
              "seconds": 1,
              "units": [
                {
                  "dateBased": true,
                  "durationEstimated": true,
                  "timeBased": true
                }
              ],
              "zero": true
            },
            "gap": true,
            "instant": "2026-07-12T01:05:03.365Z",
            "offsetAfter": {
              "id": "text",
              "totalSeconds": 1
            },
            "offsetBefore": {
              "id": "text",
              "totalSeconds": 1
            },
            "overlap": true
          }
        ]
      },
      "totalSeconds": 1
    }
  }
]

Deprecated

Create a backup schedule

post

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use POST /consoleExportSchedule

Body

application/json

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

HTTPcURLJavaScriptPython

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-07-12T01:05:03.365Z",
  "cronExpression": "text",
  "description": "text",
  "dgcBackupOptions": [
    "CONFIGURATION"
  ],
  "environmentId": "123e4567-e89b-12d3-a456-426614174000",
  "frequencyWarning": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "maxRetained": 1,
  "modifiedDate": "2026-07-12T01:05:03.365Z",
  "name": "text",
  "nextExecution": "2026-07-12T01:05:03.365Z",
  "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-07-12T01:05:03.365Z",
          "dateTimeBefore": "2026-07-12T01:05:03.365Z",
          "duration": {
            "nano": 1,
            "negative": true,
            "positive": true,
            "seconds": 1,
            "units": [
              {
                "dateBased": true,
                "durationEstimated": true,
                "timeBased": true
              }
            ],
            "zero": true
          },
          "gap": true,
          "instant": "2026-07-12T01:05:03.365Z",
          "offsetAfter": {
            "id": "text",
            "totalSeconds": 1
          },
          "offsetBefore": {
            "id": "text",
            "totalSeconds": 1
          },
          "overlap": true
        }
      ]
    },
    "totalSeconds": 1
  }
}

Deprecated

Retrieve all backup schedules for the given environment

get

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}

HTTPcURLJavaScriptPython

GET /rest/backupSchedule/environment/{environmentId} HTTP/1.1
Accept: */*

[
  {
    "createdDate": "2026-07-12T01:05:03.365Z",
    "cronExpression": "text",
    "description": "text",
    "dgcBackupOptions": [
      "CONFIGURATION"
    ],
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "frequencyWarning": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "maxRetained": 1,
    "modifiedDate": "2026-07-12T01:05:03.365Z",
    "name": "text",
    "nextExecution": "2026-07-12T01:05:03.365Z",
    "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-07-12T01:05:03.365Z",
            "dateTimeBefore": "2026-07-12T01:05:03.365Z",
            "duration": {
              "nano": 1,
              "negative": true,
              "positive": true,
              "seconds": 1,
              "units": [
                {
                  "dateBased": true,
                  "durationEstimated": true,
                  "timeBased": true
                }
              ],
              "zero": true
            },
            "gap": true,
            "instant": "2026-07-12T01:05:03.365Z",
            "offsetAfter": {
              "id": "text",
              "totalSeconds": 1
            },
            "offsetBefore": {
              "id": "text",
              "totalSeconds": 1
            },
            "overlap": true
          }
        ]
      },
      "totalSeconds": 1
    }
  }
]

Deprecated

Retrieve a backup schedule

get

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}

HTTPcURLJavaScriptPython

GET /rest/backupSchedule/{id} HTTP/1.1
Accept: */*

default

default response

{
  "createdDate": "2026-07-12T01:05:03.365Z",
  "cronExpression": "text",
  "description": "text",
  "dgcBackupOptions": [
    "CONFIGURATION"
  ],
  "environmentId": "123e4567-e89b-12d3-a456-426614174000",
  "frequencyWarning": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "maxRetained": 1,
  "modifiedDate": "2026-07-12T01:05:03.365Z",
  "name": "text",
  "nextExecution": "2026-07-12T01:05:03.365Z",
  "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-07-12T01:05:03.365Z",
          "dateTimeBefore": "2026-07-12T01:05:03.365Z",
          "duration": {
            "nano": 1,
            "negative": true,
            "positive": true,
            "seconds": 1,
            "units": [
              {
                "dateBased": true,
                "durationEstimated": true,
                "timeBased": true
              }
            ],
            "zero": true
          },
          "gap": true,
          "instant": "2026-07-12T01:05:03.365Z",
          "offsetAfter": {
            "id": "text",
            "totalSeconds": 1
          },
          "offsetBefore": {
            "id": "text",
            "totalSeconds": 1
          },
          "overlap": true
        }
      ]
    },
    "totalSeconds": 1
  }
}

Deprecated

Update a backup schedule

put

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

application/json

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}

HTTPcURLJavaScriptPython

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-07-12T01:05:03.365Z",
  "cronExpression": "text",
  "description": "text",
  "dgcBackupOptions": [
    "CONFIGURATION"
  ],
  "environmentId": "123e4567-e89b-12d3-a456-426614174000",
  "frequencyWarning": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "maxRetained": 1,
  "modifiedDate": "2026-07-12T01:05:03.365Z",
  "name": "text",
  "nextExecution": "2026-07-12T01:05:03.365Z",
  "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-07-12T01:05:03.365Z",
          "dateTimeBefore": "2026-07-12T01:05:03.365Z",
          "duration": {
            "nano": 1,
            "negative": true,
            "positive": true,
            "seconds": 1,
            "units": [
              {
                "dateBased": true,
                "durationEstimated": true,
                "timeBased": true
              }
            ],
            "zero": true
          },
          "gap": true,
          "instant": "2026-07-12T01:05:03.365Z",
          "offsetAfter": {
            "id": "text",
            "totalSeconds": 1
          },
          "offsetBefore": {
            "id": "text",
            "totalSeconds": 1
          },
          "overlap": true
        }
      ]
    },
    "totalSeconds": 1
  }
}

Deprecated

Delete a backup schedule

delete

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}

HTTPcURLJavaScriptPython

DELETE /rest/backupSchedule/{id} HTTP/1.1
Accept: */*

204

successful operation

No content

Deprecated

Retrieve all backups created by a backup schedule

get

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

HTTPcURLJavaScriptPython

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-07-12T01:05:03.365Z",
      "description": "text",
      "dgcBackupOptions": [
        "CUSTOMIZATIONS",
        "CONFIGURATION"
      ],
      "environmentId": "123e4567-e89b-12d3-a456-426614174000",
      "expirationDate": "2026-07-12T01:05:03.365Z",
      "name": "text",
      "repoBackupOptions": [
        "DATA",
        "HISTORY"
      ],
      "retentionDays": 1
    },
    "createdDate": "2026-07-12T01:05:03.365Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "inProgress": true,
    "key": "text",
    "modifiedDate": "2026-07-12T01:05:03.365Z",
    "size": 1,
    "stepStateMap": {
      "ANY_ADDITIONAL_PROPERTY": {
        "errorMessage": "text",
        "status": "UNKNOWN"
      }
    }
  }
]