Console Export

List all console export files

get

Responses

200

Successful operation

No content

401

The user is not authenticated.

get/consoleExport

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

No content

Upload a console export file

post

Body

keystringOptional

The console export password

Default: ""

retentionDaysinteger · enumOptional

Console Export retention days

Possible values:

Responses

default

default response

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

inProgressbooleanOptional

keystringOptional

modifiedDatestring · date-timeOptional

sizeinteger · int64Optional

post/consoleExport

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

{
  "files[]": {
    "content": {},
    "contentDisposition": {
      "creationDate": "2026-01-01T00:00:00.000Z",
      "fileName": "text",
      "modificationDate": "2026-01-01T00:00:00.000Z",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-01-01T00:00:00.000Z",
      "size": 1,
      "type": "text"
    },
    "entity": {},
    "fileName": "text",
    "formDataContentDisposition": {
      "creationDate": "2026-01-01T00:00:00.000Z",
      "fileName": "text",
      "modificationDate": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-01-01T00:00:00.000Z",
      "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-01-01T00:00:00.000Z",
            "fileName": "text",
            "modificationDate": "2026-01-01T00:00:00.000Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-01-01T00:00:00.000Z",
            "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-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "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-01-01T00:00:00.000Z",
        "fileName": "text",
        "modificationDate": "2026-01-01T00:00:00.000Z",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "readDate": "2026-01-01T00:00:00.000Z",
        "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-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "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-01-01T00:00:00.000Z",
                "fileName": "text",
                "modificationDate": "2026-01-01T00:00:00.000Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-01-01T00:00:00.000Z",
                "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-01-01T00:00:00.000Z",
          "fileName": "text",
          "modificationDate": "2026-01-01T00:00:00.000Z",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-01-01T00:00:00.000Z",
          "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-01-01T00:00:00.000Z",
                "fileName": "text",
                "modificationDate": "2026-01-01T00:00:00.000Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-01-01T00:00:00.000Z",
                "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-01-01T00:00:00.000Z",
                  "fileName": "text",
                  "modificationDate": "2026-01-01T00:00:00.000Z",
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "readDate": "2026-01-01T00:00:00.000Z",
                  "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-01-01T00:00:00.000Z",
            "fileName": "text",
            "modificationDate": "2026-01-01T00:00:00.000Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-01-01T00:00:00.000Z",
            "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-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "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

{
  "consoleExportInformation": {
    "appVersion": "text",
    "consoleExportSpecificationId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByEmail": "text",
    "date": "2026-01-01T00:00:00.000Z",
    "description": "text",
    "dgcConsoleExportOptions": [
      "CUSTOMIZATIONS",
      "CONFIGURATION"
    ],
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2026-01-01T00:00:00.000Z",
    "name": "text",
    "repoConsoleExportOptions": [
      "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"
    }
  }
}

Upload a console export file and process it asynchronously

post

Body

keystringOptional

The console export password

Default: ""

retentionDaysinteger · enumOptional

Console export retention days

Possible values:

Responses

default

default response

application/json

post/consoleExport/async

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

{
  "files[]": {
    "content": {},
    "contentDisposition": {
      "creationDate": "2026-01-01T00:00:00.000Z",
      "fileName": "text",
      "modificationDate": "2026-01-01T00:00:00.000Z",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-01-01T00:00:00.000Z",
      "size": 1,
      "type": "text"
    },
    "entity": {},
    "fileName": "text",
    "formDataContentDisposition": {
      "creationDate": "2026-01-01T00:00:00.000Z",
      "fileName": "text",
      "modificationDate": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "readDate": "2026-01-01T00:00:00.000Z",
      "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-01-01T00:00:00.000Z",
            "fileName": "text",
            "modificationDate": "2026-01-01T00:00:00.000Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-01-01T00:00:00.000Z",
            "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-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "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-01-01T00:00:00.000Z",
        "fileName": "text",
        "modificationDate": "2026-01-01T00:00:00.000Z",
        "parameters": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "readDate": "2026-01-01T00:00:00.000Z",
        "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-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "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-01-01T00:00:00.000Z",
                "fileName": "text",
                "modificationDate": "2026-01-01T00:00:00.000Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-01-01T00:00:00.000Z",
                "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-01-01T00:00:00.000Z",
          "fileName": "text",
          "modificationDate": "2026-01-01T00:00:00.000Z",
          "parameters": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "readDate": "2026-01-01T00:00:00.000Z",
          "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-01-01T00:00:00.000Z",
                "fileName": "text",
                "modificationDate": "2026-01-01T00:00:00.000Z",
                "parameters": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "readDate": "2026-01-01T00:00:00.000Z",
                "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-01-01T00:00:00.000Z",
                  "fileName": "text",
                  "modificationDate": "2026-01-01T00:00:00.000Z",
                  "parameters": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "readDate": "2026-01-01T00:00:00.000Z",
                  "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-01-01T00:00:00.000Z",
            "fileName": "text",
            "modificationDate": "2026-01-01T00:00:00.000Z",
            "parameters": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "readDate": "2026-01-01T00:00:00.000Z",
            "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-01-01T00:00:00.000Z",
              "fileName": "text",
              "modificationDate": "2026-01-01T00:00:00.000Z",
              "parameters": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "readDate": "2026-01-01T00:00:00.000Z",
              "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

Download a console export file

post

Path parameters

idstring · uuidRequired

The console export id

Body

keystringOptional

The console export password

Responses

200

Successful operation

No content

401

The user is not authenticated.

404

Not found

post/consoleExport/file/{id}

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

"key='text'"

No content

Delete a console export file

delete

Path parameters

idstring · uuidRequired

The ID of the console export file to delete

Responses

204

Successful operation

No content

401

The user is not authenticated.

404

Not found

delete/consoleExport/file/{id}

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

No content

Get a link to download a console export file from cloud storage

get

Path parameters

idstring · uuidRequired

The console export id

Responses

200

Successful operation

No content

401

The user is not authenticated.

404

Not found

get/consoleExport/file/{id}/link

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

No content

Get a console export by ID

get

Path parameters

consoleExportIdstring · uuidRequired

The ID of the console export to retrieve

Responses

200

Successful operation

No content

401

The user is not authenticated.

404

Not found

get/consoleExport/id/{consoleExportId}

GET /rest/consoleExport/id/{consoleExportId} HTTP/1.1
Accept: */*

No content

Create a console export file for the specified environment

post

Path parameters

environmentIdstring · uuidRequired

The ID of the environment to create console export file

Body

databasestringOptional

descriptionstringOptional

keystringOptional

namestringOptional

retentionDaysinteger · enumOptionalPossible values:

skipAppVersionbooleanOptional

Responses

200

The console export file has been created

application/json

createdDatestring · date-timeOptional

idstring · uuidOptional

inProgressbooleanOptional

keystringOptional

modifiedDatestring · date-timeOptional

sizeinteger · int64Optional

401

The user is not authenticated.

403

You do not have permission to perform this operation.

404

Environment could not be found

post/consoleExport/{environmentId}

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

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

{
  "consoleExportInformation": {
    "appVersion": "text",
    "consoleExportSpecificationId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByEmail": "text",
    "date": "2026-01-01T00:00:00.000Z",
    "description": "text",
    "dgcConsoleExportOptions": [
      "CUSTOMIZATIONS",
      "CONFIGURATION"
    ],
    "environmentId": "123e4567-e89b-12d3-a456-426614174000",
    "expirationDate": "2026-01-01T00:00:00.000Z",
    "name": "text",
    "repoConsoleExportOptions": [
      "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"
    }
  }
}

Get the global status of the current console export for the specified environment

get

Path parameters

environmentIdstring · uuidRequired

The ID of the environment

Responses

401

The user is not authenticated.

No content

404

Environment could not be found

get/consoleExport/{environmentId}/globalState

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

No content

Get the state of the current console export for the specified environment

get

Path parameters

environmentIdstring · uuidRequired

The ID of the environment

Responses

401

The user is not authenticated.

No content

404

Environment could not be found

get/consoleExport/{environmentId}/state

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

No content

Update name and/or description of an existing console export file

post

Path parameters

idstring · uuidRequired

The ID of the console export file to update

Body

descriptionstringOptional

The new description for the console export file

namestringOptional

The new name for the console export file

Responses

200

Successful operation

No content

400

Bad request

401

The user is not authenticated.

404

Not found

post/consoleExport/{id}/consoleExportInformation

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

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

No content