Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Workspaces

Export workspace or set of applications application if the authorized user is in the application's workspace. All the related children are also going to be exported. For example in case of a database application all the underlying tables, fields, views and rows are going to be exported.Roles are not part of the export.

post/api/workspaces/{workspace_id}/export/async/

Path parameters

workspace_idinteger required

The id of the workspace that must be exported.

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

Response

idinteger required
typestring required

The type of the job.

progress_percentageinteger required

A percentage indicating how far along the job is. 100 means that it's finished.

statestring required

Indicates the state of the import job.

human_readable_errorstring

A human readable error message indicating what went wrong.

created_onstring date-time required
updated_onstring date-time required
exported_file_namestring required
urlstring uri required
workspace_idinteger nullable required

The workspace that the applications are going to be exported from.