ClickHelp User Manual

[API] Create Project Backup

Creates a backup of a project in the specified location in your portal Storage with the specified file name.

POST projects/{project-id}?action=download

Authentication

This request requires basic authentication.

Request Parameters

Path params

project-id	string	The ID of the project to create a backup of.

Body params

outputFileName	string	The full file name of the output file, including the file path that starts with Storage/. Example: Storage/Backups/Project-backup_2023-03-13_03-46-07.zip

outputFileName

string

The full file name of the output file, including the file path that starts with Storage/. Example:

Storage/Backups/Project-backup_2023-03-13_03-46-07.zip

Samples

Request sample

Copy Code

Bash (Unix Shell)

curl --location 'https://{portal-url}/api/v1/projects/project-deep-space-exploration?action=download' \
--data '{
    "outputFileName": "Storage/Backups/Project-backup_2023-03-13_03-46-07.zip"
}'

Response body sample

Copy Code

JSON

{
    "taskKey": "505b063ec7434355957b3e3f91c68ea7"
}

Response fields

taskKey	The task key of the export process.

[API] Get Project Management Task Status [API] Import API definition