Container Snapshots

The Container Snapshots API lets you manage point-in-time snapshots of a container’s filesystem. Use these endpoints to list existing snapshots, create new ones, restore a container from a snapshot, update snapshot aliases, and delete snapshots you no longer need.

List Container Snapshots

GET /api/v1/containers/{id}/snapshots

Get all snapshots for a container.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	Unique identifier of the container to retrieve snapshots for

cURL

curl -X GET "https://api.hoody.com/api/v1/containers/507f1f77bcf86cd799439011/snapshots" \
  -H "Authorization: Bearer <token>"

SDK

const { data } = await client.api.containers.listSnapshotsIterator({
  id: "507f1f77bcf86cd799439011"
});

200

{
  "statusCode": 200,
  "message": "Snapshots retrieved successfully",
  "data": {
    "container_id": "507f1f77bcf86cd799439011",
    "project_id": "507f1f77bcf86cd799439033",
    "snapshots": [
      {
        "name": "snap-20250115-103000",
        "alias": "backup-2025-01-15",
        "created_at": "2025-01-15T10:30:00.000Z",
        "last_used_at": "2025-01-15T14:00:00.000Z",
        "expires_at": "2025-02-15T10:30:00.000Z",
        "stateful": false,
        "size": 2147483648
      },
      {
        "name": "snap-20250110-080000",
        "alias": "weekly-backup",
        "created_at": "2025-01-10T08:00:00.000Z",
        "last_used_at": null,
        "expires_at": null,
        "stateful": false,
        "size": 1073741824
      }
    ]
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid container ID format"
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required"
}

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions to access this container"
}

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Container not found"
}

500

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}

Create Container Snapshot

POST /api/v1/containers/{id}/snapshots

Create a new snapshot for a container. Optionally provide an alias for human-friendly identification and an expiry in days.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	Unique identifier of the container to create snapshot for

Request Body

Field	Type	Required	Description
alias	string	No	Optional user-friendly alias for the snapshot (max 100 characters)
expiry	number	No	Expiry in days

cURL

curl -X POST "https://api.hoody.com/api/v1/containers/507f1f77bcf86cd799439011/snapshots" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "alias": "pre-deployment-backup",
    "expiry": 30
  }'

SDK

const { data } = await client.api.containers.createSnapshot({
  id: "507f1f77bcf86cd799439011",
  data: {
    alias: "pre-deployment-backup",
    expiry: 30
  }
});

200

{
  "statusCode": 200,
  "message": "Snapshot created successfully",
  "data": {
    "container_id": "507f1f77bcf86cd799439011",
    "project_id": "507f1f77bcf86cd799439033",
    "snapshot": {
      "name": "snap-20250115-145500",
      "alias": "pre-deployment-backup",
      "created_at": "2025-01-15T14:55:00.000Z",
      "last_used_at": null,
      "expires_at": "2025-02-14T14:55:00.000Z",
      "stateful": false,
      "size": 2147483648
    }
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid alias: exceeds maximum length"
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required"
}

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions to snapshot this container"
}

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Container not found"
}

500

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}

Restore Container from Snapshot

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

Restore a container from a specified snapshot. This replaces the container’s current filesystem state with the contents of the snapshot.

Caution

Restoring from a snapshot is destructive: any data written to the container after the snapshot was taken will be replaced.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	Unique identifier of the container to restore
name	path	string	Yes	Name of the snapshot to restore from

cURL

curl -X PUT "https://api.hoody.com/api/v1/containers/507f1f77bcf86cd799439011/snapshots/snap-20250115-103000" \
  -H "Authorization: Bearer <token>"

SDK

const { data } = await client.api.containers.restoreSnapshot({
  id: "507f1f77bcf86cd799439011",
  name: "snap-20250115-103000"
});

200

{
  "statusCode": 200,
  "message": "Container restored from snapshot successfully",
  "data": {
    "success": true,
    "message": "Container restored from snapshot successfully",
    "snapshot": null
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Container cannot be restored in its current state"
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required"
}

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions to restore this container"
}

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Snapshot not found"
}

500

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred during restore"
}

Update Snapshot Alias

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

Update the alias of an existing snapshot. Pass null for the alias to remove an existing alias.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	Unique identifier of the container
name	path	string	Yes	Name of the snapshot to update

Request Body

Field	Type	Required	Description
alias	string | null	Yes	New alias for the snapshot. Set to null to remove alias (max 100 characters)

cURL

curl -X PUT "https://api.hoody.com/api/v1/containers/507f1f77bcf86cd799439011/snapshots/snap-20250115-103000/alias" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "alias": "production-baseline"
  }'

SDK

const { data } = await client.api.containers.updateSnapshotAlias({
  id: "507f1f77bcf86cd799439011",
  name: "snap-20250115-103000",
  data: {
    alias: "production-baseline"
  }
});

200

{
  "statusCode": 200,
  "message": "Snapshot alias updated successfully",
  "data": {
    "container_id": "507f1f77bcf86cd799439011",
    "project_id": "507f1f77bcf86cd799439033",
    "snapshot": {
      "name": "snap-20250115-103000",
      "alias": "production-baseline",
      "created_at": "2025-01-15T10:30:00.000Z",
      "last_used_at": "2025-01-15T14:00:00.000Z",
      "expires_at": "2025-02-15T10:30:00.000Z",
      "stateful": false,
      "size": 2147483648
    }
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid alias: exceeds maximum length"
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required"
}

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions to modify this snapshot"
}

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Snapshot not found"
}

500

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}

Delete Container Snapshot

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

Delete a snapshot. This action cannot be undone.

Danger

Deleting a snapshot is permanent. Make sure no workloads depend on this snapshot before deleting it.

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	Unique identifier of the container
name	path	string	Yes	Name of the snapshot to delete

cURL

curl -X DELETE "https://api.hoody.com/api/v1/containers/507f1f77bcf86cd799439011/snapshots/snap-20250110-080000" \
  -H "Authorization: Bearer <token>"

SDK

const { data } = await client.api.containers.deleteSnapshot({
  id: "507f1f77bcf86cd799439011",
  name: "snap-20250110-080000"
});

200

{
  "statusCode": 200,
  "message": "Snapshot deleted successfully",
  "data": {
    "container_id": "507f1f77bcf86cd799439011",
    "project_id": "507f1f77bcf86cd799439033",
    "snapshot_name": "snap-20250110-080000"
  }
}

400

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Cannot delete snapshot while it is in use"
}

401

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Authentication required"
}

403

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Insufficient permissions to delete this snapshot"
}

404

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Snapshot not found"
}

500

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred"
}