Create Archives
Create a task to create a ZIP, RAR, 7Z, TAR, TAR.GZ or TAR.BZ2 archive.
| Arguments | |
|---|---|
| input string or array, required | The ID of the input tasks of the files to create the archive from. Multiple task IDs can be provided as an array. |
| output_format string, required | The archive format. |
| ... optional | Conversion and engine specific options. Depends on output_format.Select the output format above to show additional conversion options. |
| {{ option.name }} optional, {{ option.type }} | Defaults to {{ option.default }}. Possible values: |
| filename string, optional | Choose a filename (including extension) for the output file. |
| engine string, optional | Use a specific engine for the conversion.
|
| engine_version string, optional | Use a specific engine version for the conversion. |
| timeout integer, optional | Timeout in seconds after the task will be cancelled. By default, tasks time out after 5 hours. |
Returns
The created task. You can find details about the task model response in the documentation about the show tasks endpoint.
Endpoint
POST https://api.cloudconvert.com/v2/archiveExample Request
$ curl -X POST "https://api.cloudconvert.com/v2/archive" \ -H "Authorization: Bearer API_KEY" \ -H "Content-type: application/json" \ -d '{ "input": [ "73df1e16-fd8b-47a1-a156-f197babde91a", "b9f3aeb1-376e-49ce-ab5f-fcfd9e3d7446" ], "output_format": "zip" }'
Example Response
{ "data": { "id": "c85f3ca9-164c-4e89-8ae2-c08192a7cb08", "operation": "archive", "status": "processing", "message": null, "created_at": "2018-09-19T14:42:58+00:00", "started_at": "2018-09-19T14:42:58+00:00", "ended_at": null, "depends_on_tasks": {}, "engine": "archivetool", "engine_version": "1.0", "payload": { "input": [ "73df1e16-fd8b-47a1-a156-f197babde91a", "b9f3aeb1-376e-49ce-ab5f-fcfd9e3d7446" ], "output_format": "zip" }, "result": null } }