Issue archive release link

Requires archive link scope and enabled archive module. Returns the URL once. The same verified gateway handles manual and print grants.

POST/api/archive/{id}/shares

Issue archive release link

curl --request POST \
  --url 'https://app.output.rocks/api/archive/123/shares' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "components": "content",
  "validityDays": 1,
  "validFrom": "2024-08-23T00:00:00+00:00",
  "maxDownloads": 1,
  "oneTime": true,
  "validityMinutes": 1,
  "accessCode": "string",
  "metadataKey": "string",
  "brandIdentifier": "string",
  "purpose": "string",
  "reference": "string"
}'

201

application/json

{
  "id": 123,
  "url": "https://example.com",
  "expiresAt": "2024-08-23T00:00:00+00:00"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

archiveOAuth

oauth2oauth2required

No description provided.

Path Parameters

integerrequired

No description provided.

Request Body

application/json

required

{
  "components": "content",
  "validityDays": 1,
  "validFrom": "2024-08-23T00:00:00+00:00",
  "maxDownloads": 1,
  "oneTime": true,
  "validityMinutes": 1,
  "accessCode": "string",
  "metadataKey": "string",
  "brandIdentifier": "string",
  "purpose": "string",
  "reference": "string"
}

Response

201application/json

Fully stored; existing response fields id, fileName, state, sha256, retentionFloorUntil, dispositionDate and link.

integer

url

string

Shown once; the token is never stored in clear text.

expiresAt

string<date-time>