/archives
POST {{base-api-url}}/archives
Here are the details of dedicated parameters of this resource:
| Fields | Descriptions |
|---|---|
expiredAt | Even if your archive is stored for 10 years, it’s possible to define an end of life date before these 10 years. The price remains unchanged but this feature allows you to better control the retention time of your data. |
tags | The tags are used to find easily your archive with your internal keywords (reference, purchase order, …). |
sha256 | The document's footprint can be known after a few seconds through a GET. This information makes it possible to verify and guarantee the integrity of the document throughout its life cycle. |
status | Here are the regarding status values: pending / finished |
archiveY | This feature is very specific and allows you to archive a document in different secure spaces with our third-party archiving partner. Please do not use this feature until you have contacted our technical team for more information. |
Request Body
{"fileName"=>"sample_document_archive.pdf", "content"=>"JVBERi0xLjUKJb/3ov4KNiAwIG9iago8PCAvTG [...] ZgoyMTYKJSVFT0YK", "expiredAt"=>"2025-10-08 23:59:00", "tags"=>["ref-order-HEY1337", "ref-customer-YS42"]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | This value is a secret and needs to be replaced by your API Key (Bearer). | |
Content-Type | string | This header specifies the format of the exchanges in JSON. |
RESPONSES
status: Created
{"id":"/archives/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","fileName":"sample_document_archive.pdf","createdAt":"2018-12-07T08:19:31+01:00","expiredAt":"2025-10-08T23:59:00+02:00","contentType":null,"size":null,"creator":null,"workspace":"/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","tags":["ref-order-hey1337","ref-customer-ys42"],"sha256":null,"status":"pending","archiveY":null}