Skip to main content

Delete Snapshot

DELETE https://infrahub-api.nexgencloud.com/v1/core/snapshots/{id}​

Permanently deletes a snapshot. Supply the snapshot ID in the path to delete the specified snapshot.


Path parameters​

id integer   Required​

The unique identifier of the snapshot to be deleted.


Attributes​

status boolean​

Indicates the result of the request to delete the snapshot. true signifies success, while false indicates an error.

message string​

A description of the status of the request to delete the snapshot.

note

If the snapshot has an associated Image, that image will also be automatically deleted with the snapshot. This message will also contain the deleted image ID, if there is one.

Example request
curl -X DELETE "https://infrahub-api.nexgencloud.com/v1/core/snapshots/{id}" \
  -H "accept: application/json"\
  -H "api_key: YOUR API KEY"
Response
{
	"status": true,
	"message": "string"
}

Returns​

Returns the status of the request to delete a snapshot. A true status indicates successful deletion, otherwise an error has occurred.

info

On Hyperstack, the following popup will appear to the user when trying to delete a Snapshot. It will ask for confirmation if the user wants to delete the associated image or not, and also provide the name and a hyperlink of that image.

If confirmed, the snapshot and its image will both be deleted. If not, nothing is deleted.

Deleting a snapshot that has an associated image on Hyperstack


Back to top​