Backup

Deprecated

List all backups

get

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

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

inProgressbooleanOptional

keystringOptional

modifiedDatestring · date-timeOptional

sizeinteger · int64Optional

get/backup

HTTPcURLJavaScriptPython

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

default

default response

[
  {
    "backupInformation": {
      "appVersion": "text",
      "backupSpecificationId": "123e4567-e89b-12d3-a456-426614174000",
      "createdByEmail": "text",
      "date": "2026-07-12T01:05:03.036Z",
      "description": "text",
      "dgcBackupOptions": [
        "CUSTOMIZATIONS",
        "CONFIGURATION"
      ],
      "environmentId": "123e4567-e89b-12d3-a456-426614174000",
      "expirationDate": "2026-07-12T01:05:03.036Z",
      "name": "text",
      "repoBackupOptions": [
        "DATA",
        "HISTORY"
      ],
      "retentionDays": 1
    },
    "createdDate": "2026-07-12T01:05:03.036Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "inProgress": true,
    "key": "text",
    "modifiedDate": "2026-07-12T01:05:03.036Z",
    "size": 1,
    "stepStateMap": {
      "ANY_ADDITIONAL_PROPERTY": {
        "errorMessage": "text",
        "status": "UNKNOWN"
      }
    }
  }
]

Deprecated

Upload a backup file

post

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

Body

*/*

keystringOptional

The backup password

Default: ""

retentionDaysinteger · enumOptional

Backup retention days

Possible values:

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

inProgressbooleanOptional

keystringOptional

modifiedDatestring · date-timeOptional

sizeinteger · int64Optional

post/backup

HTTPcURLJavaScriptPython

POST /rest/backup HTTP/1.1
Content-Type: */*
Accept: */*
Content-Length: 7543

{
  "files[]": {
    "content": {},
    "contentDisposition": {
      "creationDate": "2026-07-12T01:05:03.036Z",
      "fileName": "text",
      "modificationDate": "2026-07-12T01:05:03.036Z",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-07-12T01:05:03.036Z",
      "size": 1,
      "type": "text"
    },
    "entity": {},
    "fileName": "text",
    "formDataContentDisposition": {
      "creationDate": "2026-07-12T01:05:03.036Z",
      "fileName": "text",
      "modificationDate": "2026-07-12T01:05:03.036Z",
      "name": "text",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-07-12T01:05:03.036Z",
      "size": 1,
      "type": "text"
    },
    "headers": {
      "empty": true,
      "ANY_ADDITIONAL_PROPERTY": [
        "text"
      ]
    },
    "mediaType": {
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "subtype": "text",
      "type": "text",
      "wildcardSubtype": true,
      "wildcardType": true
    },
    "messageBodyWorkers": {},
    "name": "text",
    "parameterizedHeaders": {
      "empty": true,
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "value": "text"
        }
      ]
    },
    "parent": {
      "bodyParts": [
        {
          "contentDisposition": {
            "creationDate": "2026-07-12T01:05:03.036Z",
            "fileName": "text",
            "modificationDate": "2026-07-12T01:05:03.036Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-07-12T01:05:03.036Z",
            "size": 1,
            "type": "text"
          },
          "entity": {},
          "headers": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "mediaType": {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "subtype": "text",
            "type": "text",
            "wildcardSubtype": true,
            "wildcardType": true
          },
          "messageBodyWorkers": {},
          "parameterizedHeaders": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "value": "text"
              }
            ]
          },
          "parent": {
            "bodyParts": "[Circular Reference]",
            "contentDisposition": {
              "creationDate": "2026-07-12T01:05:03.036Z",
              "fileName": "text",
              "modificationDate": "2026-07-12T01:05:03.036Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-07-12T01:05:03.036Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": "[Circular Reference]",
            "providers": {}
          },
          "providers": {}
        }
      ],
      "contentDisposition": {
        "creationDate": "2026-07-12T01:05:03.036Z",
        "fileName": "text",
        "modificationDate": "2026-07-12T01:05:03.036Z",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "readDate": "2026-07-12T01:05:03.036Z",
        "size": 1,
        "type": "text"
      },
      "entity": {},
      "headers": {
        "empty": true,
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "mediaType": {
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "subtype": "text",
        "type": "text",
        "wildcardSubtype": true,
        "wildcardType": true
      },
      "messageBodyWorkers": {},
      "parameterizedHeaders": {
        "empty": true,
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "value": "text"
          }
        ]
      },
      "parent": {
        "bodyParts": [
          {
            "contentDisposition": {
              "creationDate": "2026-07-12T01:05:03.036Z",
              "fileName": "text",
              "modificationDate": "2026-07-12T01:05:03.036Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-07-12T01:05:03.036Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": {
              "bodyParts": "[Circular Reference]",
              "contentDisposition": {
                "creationDate": "2026-07-12T01:05:03.036Z",
                "fileName": "text",
                "modificationDate": "2026-07-12T01:05:03.036Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-07-12T01:05:03.036Z",
                "size": 1,
                "type": "text"
              },
              "entity": {},
              "headers": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  "text"
                ]
              },
              "mediaType": {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "subtype": "text",
                "type": "text",
                "wildcardSubtype": true,
                "wildcardType": true
              },
              "messageBodyWorkers": {},
              "parameterizedHeaders": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  {
                    "parameters": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "value": "text"
                  }
                ]
              },
              "parent": "[Circular Reference]",
              "providers": {}
            },
            "providers": {}
          }
        ],
        "contentDisposition": {
          "creationDate": "2026-07-12T01:05:03.036Z",
          "fileName": "text",
          "modificationDate": "2026-07-12T01:05:03.036Z",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-07-12T01:05:03.036Z",
          "size": 1,
          "type": "text"
        },
        "entity": {},
        "headers": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "mediaType": {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "subtype": "text",
          "type": "text",
          "wildcardSubtype": true,
          "wildcardType": true
        },
        "messageBodyWorkers": {},
        "parameterizedHeaders": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "value": "text"
            }
          ]
        },
        "parent": {
          "bodyParts": [
            {
              "contentDisposition": {
                "creationDate": "2026-07-12T01:05:03.036Z",
                "fileName": "text",
                "modificationDate": "2026-07-12T01:05:03.036Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-07-12T01:05:03.036Z",
                "size": 1,
                "type": "text"
              },
              "entity": {},
              "headers": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  "text"
                ]
              },
              "mediaType": {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "subtype": "text",
                "type": "text",
                "wildcardSubtype": true,
                "wildcardType": true
              },
              "messageBodyWorkers": {},
              "parameterizedHeaders": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  {
                    "parameters": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "value": "text"
                  }
                ]
              },
              "parent": {
                "bodyParts": "[Circular Reference]",
                "contentDisposition": {
                  "creationDate": "2026-07-12T01:05:03.036Z",
                  "fileName": "text",
                  "modificationDate": "2026-07-12T01:05:03.036Z",
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "readDate": "2026-07-12T01:05:03.036Z",
                  "size": 1,
                  "type": "text"
                },
                "entity": {},
                "headers": {
                  "empty": true,
                  "ANY_ADDITIONAL_PROPERTY": [
                    "text"
                  ]
                },
                "mediaType": {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "subtype": "text",
                  "type": "text",
                  "wildcardSubtype": true,
                  "wildcardType": true
                },
                "messageBodyWorkers": {},
                "parameterizedHeaders": {
                  "empty": true,
                  "ANY_ADDITIONAL_PROPERTY": [
                    {
                      "parameters": {
                        "ANY_ADDITIONAL_PROPERTY": "text"
                      },
                      "value": "text"
                    }
                  ]
                },
                "parent": "[Circular Reference]",
                "providers": {}
              },
              "providers": {}
            }
          ],
          "contentDisposition": {
            "creationDate": "2026-07-12T01:05:03.036Z",
            "fileName": "text",
            "modificationDate": "2026-07-12T01:05:03.036Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-07-12T01:05:03.036Z",
            "size": 1,
            "type": "text"
          },
          "entity": {},
          "headers": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "mediaType": {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "subtype": "text",
            "type": "text",
            "wildcardSubtype": true,
            "wildcardType": true
          },
          "messageBodyWorkers": {},
          "parameterizedHeaders": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "value": "text"
              }
            ]
          },
          "parent": {
            "bodyParts": "[Circular Reference]",
            "contentDisposition": {
              "creationDate": "2026-07-12T01:05:03.036Z",
              "fileName": "text",
              "modificationDate": "2026-07-12T01:05:03.036Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-07-12T01:05:03.036Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": "[Circular Reference]",
            "providers": {}
          },
          "providers": {}
        },
        "providers": {}
      },
      "providers": {}
    },
    "providers": {},
    "simple": true,
    "value": "text"
  },
  "key": "",
  "retentionDays": 7
}

default

default response

{
  "backupInformation": {
    "appVersion": "text",
    "backupSpecificationId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByEmail": "text",
    "date": "2026-07-12T01:05:03.036Z",
    "description": "text",
    "dgcBackupOptions": [
      "CUSTOMIZATIONS",
      "CONFIGURATION"
    ],
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2026-07-12T01:05:03.036Z",
    "name": "text",
    "repoBackupOptions": [
      "DATA",
      "HISTORY"
    ],
    "retentionDays": 1
  },
  "createdDate": "2026-07-12T01:05:03.036Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inProgress": true,
  "key": "text",
  "modifiedDate": "2026-07-12T01:05:03.036Z",
  "size": 1,
  "stepStateMap": {
    "ANY_ADDITIONAL_PROPERTY": {
      "errorMessage": "text",
      "status": "UNKNOWN"
    }
  }
}

Deprecated

Upload a backup file and process it asynchronously

post

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

Body

*/*

keystringOptional

The backup password

Default: ""

retentionDaysinteger · enumOptional

Backup retention days

Possible values:

Responses

default

default response

application/json

post/backup/async

HTTPcURLJavaScriptPython

POST /rest/backup/async HTTP/1.1
Content-Type: */*
Accept: */*
Content-Length: 7543

{
  "files[]": {
    "content": {},
    "contentDisposition": {
      "creationDate": "2026-07-12T01:05:03.036Z",
      "fileName": "text",
      "modificationDate": "2026-07-12T01:05:03.036Z",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-07-12T01:05:03.036Z",
      "size": 1,
      "type": "text"
    },
    "entity": {},
    "fileName": "text",
    "formDataContentDisposition": {
      "creationDate": "2026-07-12T01:05:03.036Z",
      "fileName": "text",
      "modificationDate": "2026-07-12T01:05:03.036Z",
      "name": "text",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-07-12T01:05:03.036Z",
      "size": 1,
      "type": "text"
    },
    "headers": {
      "empty": true,
      "ANY_ADDITIONAL_PROPERTY": [
        "text"
      ]
    },
    "mediaType": {
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "subtype": "text",
      "type": "text",
      "wildcardSubtype": true,
      "wildcardType": true
    },
    "messageBodyWorkers": {},
    "name": "text",
    "parameterizedHeaders": {
      "empty": true,
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "value": "text"
        }
      ]
    },
    "parent": {
      "bodyParts": [
        {
          "contentDisposition": {
            "creationDate": "2026-07-12T01:05:03.036Z",
            "fileName": "text",
            "modificationDate": "2026-07-12T01:05:03.036Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-07-12T01:05:03.036Z",
            "size": 1,
            "type": "text"
          },
          "entity": {},
          "headers": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "mediaType": {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "subtype": "text",
            "type": "text",
            "wildcardSubtype": true,
            "wildcardType": true
          },
          "messageBodyWorkers": {},
          "parameterizedHeaders": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "value": "text"
              }
            ]
          },
          "parent": {
            "bodyParts": "[Circular Reference]",
            "contentDisposition": {
              "creationDate": "2026-07-12T01:05:03.036Z",
              "fileName": "text",
              "modificationDate": "2026-07-12T01:05:03.036Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-07-12T01:05:03.036Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": "[Circular Reference]",
            "providers": {}
          },
          "providers": {}
        }
      ],
      "contentDisposition": {
        "creationDate": "2026-07-12T01:05:03.036Z",
        "fileName": "text",
        "modificationDate": "2026-07-12T01:05:03.036Z",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "readDate": "2026-07-12T01:05:03.036Z",
        "size": 1,
        "type": "text"
      },
      "entity": {},
      "headers": {
        "empty": true,
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "mediaType": {
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "subtype": "text",
        "type": "text",
        "wildcardSubtype": true,
        "wildcardType": true
      },
      "messageBodyWorkers": {},
      "parameterizedHeaders": {
        "empty": true,
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "value": "text"
          }
        ]
      },
      "parent": {
        "bodyParts": [
          {
            "contentDisposition": {
              "creationDate": "2026-07-12T01:05:03.036Z",
              "fileName": "text",
              "modificationDate": "2026-07-12T01:05:03.036Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-07-12T01:05:03.036Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": {
              "bodyParts": "[Circular Reference]",
              "contentDisposition": {
                "creationDate": "2026-07-12T01:05:03.036Z",
                "fileName": "text",
                "modificationDate": "2026-07-12T01:05:03.036Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-07-12T01:05:03.036Z",
                "size": 1,
                "type": "text"
              },
              "entity": {},
              "headers": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  "text"
                ]
              },
              "mediaType": {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "subtype": "text",
                "type": "text",
                "wildcardSubtype": true,
                "wildcardType": true
              },
              "messageBodyWorkers": {},
              "parameterizedHeaders": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  {
                    "parameters": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "value": "text"
                  }
                ]
              },
              "parent": "[Circular Reference]",
              "providers": {}
            },
            "providers": {}
          }
        ],
        "contentDisposition": {
          "creationDate": "2026-07-12T01:05:03.036Z",
          "fileName": "text",
          "modificationDate": "2026-07-12T01:05:03.036Z",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-07-12T01:05:03.036Z",
          "size": 1,
          "type": "text"
        },
        "entity": {},
        "headers": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "mediaType": {
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "subtype": "text",
          "type": "text",
          "wildcardSubtype": true,
          "wildcardType": true
        },
        "messageBodyWorkers": {},
        "parameterizedHeaders": {
          "empty": true,
          "ANY_ADDITIONAL_PROPERTY": [
            {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "value": "text"
            }
          ]
        },
        "parent": {
          "bodyParts": [
            {
              "contentDisposition": {
                "creationDate": "2026-07-12T01:05:03.036Z",
                "fileName": "text",
                "modificationDate": "2026-07-12T01:05:03.036Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-07-12T01:05:03.036Z",
                "size": 1,
                "type": "text"
              },
              "entity": {},
              "headers": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  "text"
                ]
              },
              "mediaType": {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "subtype": "text",
                "type": "text",
                "wildcardSubtype": true,
                "wildcardType": true
              },
              "messageBodyWorkers": {},
              "parameterizedHeaders": {
                "empty": true,
                "ANY_ADDITIONAL_PROPERTY": [
                  {
                    "parameters": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "value": "text"
                  }
                ]
              },
              "parent": {
                "bodyParts": "[Circular Reference]",
                "contentDisposition": {
                  "creationDate": "2026-07-12T01:05:03.036Z",
                  "fileName": "text",
                  "modificationDate": "2026-07-12T01:05:03.036Z",
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "readDate": "2026-07-12T01:05:03.036Z",
                  "size": 1,
                  "type": "text"
                },
                "entity": {},
                "headers": {
                  "empty": true,
                  "ANY_ADDITIONAL_PROPERTY": [
                    "text"
                  ]
                },
                "mediaType": {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "subtype": "text",
                  "type": "text",
                  "wildcardSubtype": true,
                  "wildcardType": true
                },
                "messageBodyWorkers": {},
                "parameterizedHeaders": {
                  "empty": true,
                  "ANY_ADDITIONAL_PROPERTY": [
                    {
                      "parameters": {
                        "ANY_ADDITIONAL_PROPERTY": "text"
                      },
                      "value": "text"
                    }
                  ]
                },
                "parent": "[Circular Reference]",
                "providers": {}
              },
              "providers": {}
            }
          ],
          "contentDisposition": {
            "creationDate": "2026-07-12T01:05:03.036Z",
            "fileName": "text",
            "modificationDate": "2026-07-12T01:05:03.036Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-07-12T01:05:03.036Z",
            "size": 1,
            "type": "text"
          },
          "entity": {},
          "headers": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "mediaType": {
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "subtype": "text",
            "type": "text",
            "wildcardSubtype": true,
            "wildcardType": true
          },
          "messageBodyWorkers": {},
          "parameterizedHeaders": {
            "empty": true,
            "ANY_ADDITIONAL_PROPERTY": [
              {
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "value": "text"
              }
            ]
          },
          "parent": {
            "bodyParts": "[Circular Reference]",
            "contentDisposition": {
              "creationDate": "2026-07-12T01:05:03.036Z",
              "fileName": "text",
              "modificationDate": "2026-07-12T01:05:03.036Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-07-12T01:05:03.036Z",
              "size": 1,
              "type": "text"
            },
            "entity": {},
            "headers": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                "text"
              ]
            },
            "mediaType": {
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "subtype": "text",
              "type": "text",
              "wildcardSubtype": true,
              "wildcardType": true
            },
            "messageBodyWorkers": {},
            "parameterizedHeaders": {
              "empty": true,
              "ANY_ADDITIONAL_PROPERTY": [
                {
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "value": "text"
                }
              ]
            },
            "parent": "[Circular Reference]",
            "providers": {}
          },
          "providers": {}
        },
        "providers": {}
      },
      "providers": {}
    },
    "providers": {},
    "simple": true,
    "value": "text"
  },
  "key": "",
  "retentionDays": 7
}

default

default response

Deprecated

Download a backup file

post

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use POST /consoleExport/file/{id}

Path parameters

idstring · uuidRequired

The backup id

Body

application/x-www-form-urlencoded

keystringOptional

The backup password

Responses

200

successful operation

No content

404

not found

post/backup/file/{id}

HTTPcURLJavaScriptPython

POST /rest/backup/file/{id} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 14

"key='text'"

No content

Deprecated

Delete a backup

delete

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use DELETE /consoleExport/file/{id}

Path parameters

idstring · uuidRequired

The ID of the backup to delete

Responses

204

successful operation

No content

delete/backup/file/{id}

HTTPcURLJavaScriptPython

DELETE /rest/backup/file/{id} HTTP/1.1
Accept: */*

204

successful operation

No content

Deprecated

Get a link to download a backup file from cloud storage

get

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use GET /consoleExport/file/{id}/link

Path parameters

idstring · uuidRequired

The backup id

Responses

200

successful operation

No content

404

not found

get/backup/file/{id}/link

HTTPcURLJavaScriptPython

GET /rest/backup/file/{id}/link HTTP/1.1
Accept: */*

No content

Deprecated

Get a backup by ID

get

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use GET /consoleExport/id/{consoleExportId}

Path parameters

backupIdstring · uuidRequired

The ID of the backup to retrieve

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

inProgressbooleanOptional

keystringOptional

modifiedDatestring · date-timeOptional

sizeinteger · int64Optional

get/backup/id/{backupId}

HTTPcURLJavaScriptPython

GET /rest/backup/id/{backupId} HTTP/1.1
Accept: */*

default

default response

{
  "backupInformation": {
    "appVersion": "text",
    "backupSpecificationId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByEmail": "text",
    "date": "2026-07-12T01:05:03.036Z",
    "description": "text",
    "dgcBackupOptions": [
      "CUSTOMIZATIONS",
      "CONFIGURATION"
    ],
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2026-07-12T01:05:03.036Z",
    "name": "text",
    "repoBackupOptions": [
      "DATA",
      "HISTORY"
    ],
    "retentionDays": 1
  },
  "createdDate": "2026-07-12T01:05:03.036Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inProgress": true,
  "key": "text",
  "modifiedDate": "2026-07-12T01:05:03.036Z",
  "size": 1,
  "stepStateMap": {
    "ANY_ADDITIONAL_PROPERTY": {
      "errorMessage": "text",
      "status": "UNKNOWN"
    }
  }
}

Deprecated

Create a backup for the specified environment

post

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use POST /consoleExport/{environmentId}

Path parameters

environmentIdstring · uuidRequired

The ID of the environment to backup

Body

application/json

databasestringOptional

descriptionstringOptional

keystringOptional

namestringOptional

retentionDaysinteger · enumOptionalPossible values:

skipAppVersionbooleanOptional

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

inProgressbooleanOptional

keystringOptional

modifiedDatestring · date-timeOptional

sizeinteger · int64Optional

post/backup/{environmentId}

HTTPcURLJavaScriptPython

POST /rest/backup/{environmentId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "database": "text",
  "description": "text",
  "dgcBackupOptions": [
    "CUSTOMIZATIONS",
    "CONFIGURATION"
  ],
  "key": "text",
  "name": "text",
  "repoBackupOptions": [
    "DATA",
    "HISTORY"
  ],
  "retentionDays": 7,
  "skipAppVersion": true
}

default

default response

{
  "backupInformation": {
    "appVersion": "text",
    "backupSpecificationId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByEmail": "text",
    "date": "2026-07-12T01:05:03.036Z",
    "description": "text",
    "dgcBackupOptions": [
      "CUSTOMIZATIONS",
      "CONFIGURATION"
    ],
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2026-07-12T01:05:03.036Z",
    "name": "text",
    "repoBackupOptions": [
      "DATA",
      "HISTORY"
    ],
    "retentionDays": 1
  },
  "createdDate": "2026-07-12T01:05:03.036Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inProgress": true,
  "key": "text",
  "modifiedDate": "2026-07-12T01:05:03.036Z",
  "size": 1,
  "stepStateMap": {
    "ANY_ADDITIONAL_PROPERTY": {
      "errorMessage": "text",
      "status": "UNKNOWN"
    }
  }
}

Deprecated

Get the global status of the current backup for the specified environment

get

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use GET /consoleExport/{environmentId}/globalState

Path parameters

environmentIdstring · uuidRequired

The ID of the environment

Responses

default

default response

application/json

booleanOptional

get/backup/{environmentId}/globalState

HTTPcURLJavaScriptPython

GET /rest/backup/{environmentId}/globalState HTTP/1.1
Accept: */*

default

default response

true

Deprecated

Get the state of the current backup for the specified environment

get

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use GET /consoleExport/{environmentId}/state

Path parameters

environmentIdstring · uuidRequired

The ID of the environment

Responses

default

default response

application/json

get/backup/{environmentId}/state

HTTPcURLJavaScriptPython

GET /rest/backup/{environmentId}/state HTTP/1.1
Accept: */*

default

default response

Deprecated

Update name and/or description of an existing backup

post

This endpoint is deprecated since 2025.05 and will be removed in the future. Please use POST /consoleExport/{id}/consoleExportInformation

Path parameters

idstring · uuidRequired

Body

application/x-www-form-urlencoded

descriptionstringOptional

The new description for the backup

namestringOptional

The new name for the backup

Responses

200

successful operation

No content

404

not found

post/backup/{id}/backupinformation

HTTPcURLJavaScriptPython

POST /rest/backup/{id}/backupinformation HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 36

"description='text'&name='text'"

No content