prune-archived-data.md

prune-archived-data

To delete data that has been archived from your Aidbox database you can make /execution/aidbox.archive/prune-archived-data request. You also can make this automatically with pruneArchivedData parameter of create-archive request.

prune-archived-data properties:

Properties	Required	Description
archiveId	true	archiveId property of succeeded create-archive response if it archived at least 1 row.

{% tabs %} {% tab title="Request" %}

POST /execution/aidbox.archive/prune-archived-data
accept: text/yaml
content-type: text/yaml

archiveId: ace351aa-ad5a-44a7-8314-532628e7d9ae

{% endtab %}

{% tab title="Response" %}

Status: 201

id: 51991757-8c7f-4d1c-9a49-16dbd6b68fae

{% endtab %} {% endtabs %}

To fetch status of the task make /execution/aidbox.archive/prune-archived-data/[task_id] request with id from prune-archived-data response:

{% tabs %} {% tab title="Request" %}

GET /execution/aidbox.archive/prune-archived-data/51991757-8c7f-4d1c-9a49-16dbd6b68fae
accept: text/yaml
content-type: text/yaml

{% endtab %}

{% tab title="Response" %}

Status: 200

definition: aidbox.archive/prune-archived-data
meta:
  lastUpdated: '2023-01-10T11:32:40.407637Z'
  createdAt: '2023-01-10T11:32:40.367675Z'
  versionId: '26174'
params:
  archiveId: ace351aa-ad5a-44a7-8314-532628e7d9ae
retryCount: 1
outcome: succeeded
resourceType: AidboxTask
requester:
  id: >-
    admin
  resourceType: User
status: done
result:
  deleteRowsCount: 30
execId: 39fd4f76-c9a3-4e6e-ac35-74eb4241d57a
id: >-
  51991757-8c7f-4d1c-9a49-16dbd6b68fae

{% endtab %} {% endtabs %}