Drive > Files > Share link > Archive

Build archive

Build an archive from files in the share link. The archive can then be downloaded using the <a href="/docs/api/get/2/drive/{drive_id}/share/{sharelink_uuid}/download">drive/{drive_id}/share/{sharelink_uuid}/download</a> route. </br></br><note> The file identifiers should be in the same parent directory. </note> </br><note> The archive should contain at least one file and may not contain more than 20,000 files. </note>

post/2/app/{drive_id}/share/{sharelink_uuid}/archive

Path parameters

drive_idinteger required

Drive identifier

sharelink_uuidinteger required

Sharelink token

Request body

except_file_idsinteger[]

Array of files to exclude from the request; only used when parent_id is set, meaningless otherwise

file_idsinteger[]

Array of files to include in the request; required without parent_id

parent_idinteger

The directory containing the files to include in the request; required without file_ids

Response

Created

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

data91ac10ffArchiveResource — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.