Skip to documentation
GETBearer token

List snapshots

/api/v1/servers/:id/snapshots

Read server snapshots and the snapshot limit. A listed snapshot is not proof that supplier restore is ready.

Request example

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/snapshots" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Examples only. No requests are sent from this page.

Parameters

idPath · Required

string

Resource ID: 24 hexadecimal characters. Use the platform ID returned by the matching list endpoint, not a supplier instance ID.

Response

HTTP status 200

Read the snapshot allowance and currently listed snapshots for an owned server.

limitnumber

Snapshot allowance for the plan.

snapshotsarray

Snapshot records returned by the current provider or preview data.

snapshots[].idstring

Snapshot identifier.

snapshots[].namestring

Snapshot name.

snapshots[].instanceIdstring

Supplier instance identifier.

snapshots[].descriptionstring | null (optional)

Snapshot description.

snapshots[].createdAtstring (optional)

Provider creation-date value, when supplied.

snapshots[].autoDeleteAtstring (optional)

Provider auto-deletion date, when supplied.

snapshots[].imageIdstring (optional)

Provider image identifier, when supplied.

snapshots[].imageNamestring (optional)

Provider image name, when supplied.

simulatedboolean (true, optional)

Present for isolated test inventory; its snapshot list is empty.