Snapshots

Hold Snapshot

Places a user hold on an Eon snapshot. Snapshots with user holds are protected from removal even if their expiration time passes.

<Note> Point-in-time recovery (PiTR) snapshots can't be placed on hold. </Note>
patch/v1/projects/{projectId}/snapshots/{id}/hold

Request

  • Base URL: https://%7Baccount-domain%7D.console.eon.io/api
  • URL: https://%7Baccount-domain%7D.console.eon.io/api/v1/projects/{projectId}/snapshots/{id}/hold
  • Auth: HTTP bearer

Path parameters

projectIdstring uuid required

ID of the project the snapshot is in. You can get your project ID from the API Credentials page in your global management console.

idstring uuid required

ID of the Eon snapshot.

Request body

descriptionstring

Note explaining why the snapshot is being held. Cleared when the hold is removed.

Response

Hold was placed on the snapshot.

SnapshotsHoldSnapshotResponse200 required

Changes

No recorded changes to this operation across all 1 revision of this API.