For the complete documentation index, see llms.txt. This page is also available as Markdown.

Console Export

List all console export files

get
Responses
200

Successful operation

No content

get/consoleExport

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
default

default response

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
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

post/consoleExport/file/{id}

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

delete/consoleExport/file/{id}

No content

get
Path parameters
idstring · uuidRequired

The console export id

Responses
200

Successful operation

No content

get/consoleExport/file/{id}/link

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

get/consoleExport/id/{consoleExportId}

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
post/consoleExport/{environmentId}

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

get/consoleExport/{environmentId}/globalState

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

get/consoleExport/{environmentId}/state

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

post/consoleExport/{id}/consoleExportInformation

No content

Last updated

Was this helpful?