Apply Console Export

Apply a console export to an environment

post

Path parameters

environmentIdstring · uuidRequired

The ID of the target environment

Body

application/json

consoleExportIdstring · uuidOptional

consoleExportVersionstringOptional

databasestringOptional

keystringOptional

resetCustomizationsbooleanOptional

skipApplyConsoleExportPostprocessingbooleanOptional

Responses

default

default response

*/*

post/applyConsoleExport/{environmentId}

HTTPcURLJavaScriptPython

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

{
  "consoleExportId": "123e4567-e89b-12d3-a456-426614174000",
  "consoleExportVersion": "text",
  "database": "text",
  "dgcApplyConsoleExportOptions": [
    "CUSTOMIZATIONS",
    "CONFIGURATION"
  ],
  "key": "text",
  "managedServiceTypes": [
    "REPOSITORY"
  ],
  "repoApplyConsoleExportOptions": [
    "DATA",
    "HISTORY"
  ],
  "resetCustomizations": true,
  "skipApplyConsoleExportPostprocessing": true
}

default

default response

Cancel an apply console export operation in progress

put

Path parameters

environmentIdstring · uuidRequired

The ID of the target environment

Responses

default

default response

*/*

put/applyConsoleExport/{environmentId}/cancel

HTTPcURLJavaScriptPython

PUT /rest/applyConsoleExport/{environmentId}/cancel HTTP/1.1
Accept: */*

default

default response

Apply factory defaults to an environment

post

Path parameters

environmentIdstring · uuidRequired

The ID of the target environment

Responses

default

default response

*/*

post/applyConsoleExport/{environmentId}/factoryDefaults

HTTPcURLJavaScriptPython

POST /rest/applyConsoleExport/{environmentId}/factoryDefaults HTTP/1.1
Accept: */*

default

default response

Retrieve the state of all steps of the apply console export operation on a specified environment

get

Path parameters

environmentIdstring · uuidRequired

The ID of the target environment

Responses

default

default response

application/json

get/applyConsoleExport/{environmentId}/state

HTTPcURLJavaScriptPython

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

default

default response