Report retention start event

Releases the technical event hold only after all pinned WORM artifacts have the resulting retain-until.

POST/api/archive/{id}/retention-event

Report retention start event

curl --request POST \
  --url 'https://app.output.rocks/api/archive/123/retention-event' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "expectedRevision": 1,
  "reason": "string",
  "idempotencyKey": "string",
  "eventDate": "2024-08-23"
}'

202

application/json

{
  "operationId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "revision": 1,
  "expectedRevision": 1,
  "attempts": 1,
  "error": "string",
  "kind": "string",
  "certificate": {}
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

archiveOAuth

oauth2oauth2required

No description provided.

Path Parameters

integerrequired

No description provided.

Header Parameters

Idempotency-Key

string

Required here or as idempotencyKey in the body. Both, if given, must agree. Changed inputs conflict.

Request Body

application/json

required

{
  "expectedRevision": 1,
  "reason": "string",
  "idempotencyKey": "string",
  "eventDate": "2024-08-23"
}

Response

202application/json

Durably accepted; follow Location until confirmed.

operationId

string<uuid>required

status

enum<string>required

Available options: pendingadmittedconfirmed

revision

integer

expectedRevision

integer

attempts

integer

error

string | null

kind

string

certificate

object | null