Skip to main content

Storage SnapLock event-retention operations endpoint overview

Contributors
PDFs

Use this API to display all Event Based Retention (EBR) operations and to apply an EBR policy on a specified volume or path within the volume. Only a user with security login role vsadmin-snaplock can perform the operation.

Examples

  1. Displays all of the EBR operations:

 GET "/api/storage/snaplock/event-retention/operations"

  1. Displays all completed EBR operations:

 GET "/api/storage/snaplock/event-retention/operations?state=completed"

  1. Displays all completed EBR operations with filter set as volume.uuid:

 GET "/api/storage/snaplock/event-retention/operations?volume.uuid=b96f976e-404b-11e9-bff2-0050568e4dbe"

  1. Displays all of the EBR operations with filter set as volume.name:

 GET "/api/storage/snaplock/event-retention/operations?volume.name=SLCVOL"

Examples

  1. Applies an EBR policy on a specific path:

 POST "/api/storage/snaplock/event-retention/operations" '{"volume.name":"SLCVOL", "policy.name":"p1day", "path":"/dir1/file.txt"}'

  1. Applies an EBR policy on the complete volume:

 POST "/api/storage/snaplock/event-retention/operations" '{"volume.name":"SLCVOL", "policy.name":"p1day", "path":"/"}'

Example

DELETE "/api/storage/snaplock/event-retention/operations/16842999"