Skip to content

Beta: these docs are still being updated. The next full update is on 18 November at 8 PM UTC. Docs in beta. Full update 18 Nov, 8 PM UTC.

Hoody.com

Create, restore, alias, and delete snapshots of a computer. Use these endpoints to capture a point-in-time copy of a computer before a change, restore a computer to an earlier state, attach a human-friendly alias to a snapshot, or free snapshot capacity by deleting old copies.

All five endpoints are served by the control plane at https://api.hoody.com and require a Hoody account token in the Authorization header. A computer is addressed by its id, and a snapshot by its canonical name as returned by the list endpoint.

In the Hub, open Computers, select the computer, and open Backups. Choose Take snapshot to create one, Restore on a snapshot to restore it, or its menu for Rename label and Delete.

Get all snapshots for a computer. The response includes the snapshot count and the maximum number of snapshots the computer may hold. The whole list is returned in a single response, with no paging.

This endpoint takes no request body.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to retrieve snapshots for
Terminal window
curl -X GET "https://api.hoody.com/api/v1/computers/890abcdef12345678901cdef/snapshots" \
-H "Authorization: Bearer $HOODY_TOKEN"

Create a new snapshot for a computer.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to create snapshot for

The request body is required.

NameTypeRequiredDescription
aliasstringNoUser-friendly alias for the snapshot. It is kept as the alias and also becomes the snapshot name after sanitizing. Letters, digits, underscores, and hyphens are kept, while leading and trailing hyphens and underscores are stripped. The sanitized name is at most 64 characters. If sanitizing leaves exactly one character, the request is refused with 400. If it leaves nothing, a timestamped name is used. An alias with control or invisible characters is refused with 400. Maximum length: 100.
expiryintegerNoExpiry in days, from 1 to 3650. Values outside this range are rejected before the snapshot is created.
{
"alias": "pre-deployment-backup",
"expiry": 30
}
Terminal window
curl -X POST "https://api.hoody.com/api/v1/computers/890abcdef12345678901cdef/snapshots" \
-H "Authorization: Bearer $HOODY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"alias": "pre-deployment-backup",
"expiry": 30
}'

PUT /api/v1/computers/{id}/snapshots/{name}

Section titled “PUT /api/v1/computers/{id}/snapshots/{name}”

Restore a computer from a snapshot.

The server also accepts PATCH for this route, with identical behavior.

This endpoint takes no request body.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to restore
namepathstringYesThe snapshot’s canonical name as returned by the list endpoint. For a snapshot created with an alias, this is the sanitized alias: letters, digits, underscores, and hyphens are kept, while leading and trailing hyphens and underscores are stripped. The name is at most 64 characters. Without an alias, or when sanitization leaves nothing, it is a timestamped snap-YYYYMMDD-HHMMSS value.
Terminal window
curl -X PUT "https://api.hoody.com/api/v1/computers/890abcdef12345678901cdef/snapshots/snap-20250115-103000" \
-H "Authorization: Bearer $HOODY_TOKEN"

PUT /api/v1/computers/{id}/snapshots/{name}/alias

Section titled “PUT /api/v1/computers/{id}/snapshots/{name}/alias”

Update the alias of an existing snapshot.

The server also accepts PATCH for this route, with identical behavior.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer
namepathstringYesThe snapshot’s canonical name as returned by the list endpoint. For a snapshot created with an alias, this is the sanitized alias: letters, digits, underscores, and hyphens are kept, while leading and trailing hyphens and underscores are stripped. The name is at most 64 characters. Without an alias, or when sanitization leaves nothing, it is a timestamped snap-YYYYMMDD-HHMMSS value.

The request body is required.

NameTypeRequiredDescription
aliasstring or nullYesNew alias for the snapshot. Set it to null to remove the alias. Maximum length: 100.
{
"alias": "production-baseline"
}
Terminal window
curl -X PUT "https://api.hoody.com/api/v1/computers/890abcdef12345678901cdef/snapshots/snap-20250115-103000/alias" \
-H "Authorization: Bearer $HOODY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"alias": "production-baseline"
}'

DELETE /api/v1/computers/{id}/snapshots/{name}

Section titled “DELETE /api/v1/computers/{id}/snapshots/{name}”

Delete a snapshot.

This endpoint takes no request body.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer
namepathstringYesThe snapshot’s canonical name as returned by the list endpoint. For a snapshot created with an alias, this is the sanitized alias: letters, digits, underscores, and hyphens are kept, while leading and trailing hyphens and underscores are stripped. The name is at most 64 characters. Without an alias, or when sanitization leaves nothing, it is a timestamped snap-YYYYMMDD-HHMMSS value.
Terminal window
curl -X DELETE "https://api.hoody.com/api/v1/computers/890abcdef12345678901cdef/snapshots/snap-20250110-080000" \
-H "Authorization: Bearer $HOODY_TOKEN"