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

Copy a computer into another project or server, and request a sync between a copy and its source. Use the copy endpoint to duplicate an existing computer, for example to hand a workload to another project or to place it on a dedicated server. The sync endpoint is reserved for computers that were created by copying and currently refuses every request that passes its checks, so copy the source again to get its latest files.

In the Hub, open Computers, choose Make a copy… from the source computer’s menu, enter a name, choose the server and project, then select Make copy.

POST /api/v1/computers/{id}/copy

Creates a copy of an existing computer. The copy operation runs asynchronously and the new computer starts automatically upon successful completion. The response carries the new computer with status set to copying and an operation_id. The computer.operation.completed or computer.operation.failed event reports the outcome and carries the same operation_id. If the copy fails, the new computer’s status becomes failed and it cannot be started, so delete it and retry the copy.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the source computer to copy.
NameTypeRequiredDescription
target_project_idstringYesID of the project where the copy will be created. A 24-character hexadecimal string.
target_server_idstringNoID of the server where the copy will be created. Defaults to the source server. A 24-character hexadecimal string.
namestringNoName for the copied computer, auto-generated if not provided. 3 to 100 characters, letters, digits, - and _ only.
ssh_public_keystring, nullableNoSSH public key for the copied computer. It must be unique and is not inherited from the source.
source_snapshotstringNoSpecific snapshot to copy from. Copies the latest state if not provided. Letters, digits, - and _ only. An auth token needs computers.features.snapshots to use it.
copy_firewall_rulesbooleanNoWhether to copy firewall rules from the source computer to the target computer. Default: false.
copy_network_rulesbooleanNoWhether to copy network rules and settings from the source computer to the target computer. Default: false.
kvmbooleanNoGrant the copy the /dev/kvm passthrough so it can run full VMs. The copy never inherits the source’s KVM grant, so this decides KVM for the copy independently, on the target server. Available on rented or dedicated (bare-metal) targets only, never free tier, and refused with 403 otherwise. Default: false.
dev_kvmbooleanNoAccepted alias of kvm on input. kvm wins if both are sent, and they must agree.
{
"target_project_id": "67e89abc123def456789abcd",
"target_server_id": "2a3b4c5d6e7f8091a2b3c4d5",
"name": "web-frontend-copy",
"ssh_public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGQ2F3vJ8l7mXn0cQK1pS9tY4uV6wX7yZ8aB9cD0eF1g deploy@ci",
"copy_firewall_rules": true,
"copy_network_rules": true,
"kvm": true
}
Terminal window
curl -X POST "https://api.hoody.com/api/v1/computers/4501a2b3c4d5e6f7a8b9c0d1/copy" \
-H "Authorization: Bearer $HOODY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"target_project_id": "67e89abc123def456789abcd",
"target_server_id": "2a3b4c5d6e7f8091a2b3c4d5",
"name": "web-frontend-copy",
"ssh_public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGQ2F3vJ8l7mXn0cQK1pS9tY4uV6wX7yZ8aB9cD0eF1g deploy@ci",
"copy_firewall_rules": true,
"copy_network_rules": true,
"kvm": true
}'

Every error response carries statusCode (number), error (string) and message (string), plus data with additional error details when the error carries any.

Media type: application/json

The copy was accepted and started.

{
"statusCode": 201,
"message": "Computer copy initiated successfully",
"data": {
"id": "890abcdef12345678901cdef",
"name": "web-frontend-copy",
"status": "copying",
"source_computer_id": "4501a2b3c4d5e6f7a8b9c0d1",
"project_id": "67e89abc123def456789abcd",
"project_alias": "platform",
"server_id": "2a3b4c5d6e7f8091a2b3c4d5",
"server_name": "node-example-1",
"subserver_name": "node-example-1-rental-01",
"ssh_hostname": "67e89abc123def456789abcd-890abcdef12345678901cdef-ssh.node-example-1.computers.hoody.com",
"color": "#3B82F6",
"computer_image": "debian/13",
"ai": false,
"hoody_kit": true,
"dev_kit": false,
"kvm": false,
"autostart": true,
"ramdisk_scope": "computer",
"ramdisk": false,
"is_default": false,
"computer_image_id": "6501a2b3c4d5e6f7a8b9c0d1",
"environment_vars": {},
"volumes": {},
"ssh_public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGQ2F3vJ8l7mXn0cQK1pS9tY4uV6wX7yZ8aB9cD0eF1g deploy@ci",
"ssh_key_fingerprint": "SHA256:wBF5vmw/82L9++9kd8PEmcEkErv5hBWXC7aJsuXAyh8",
"ssh_key_installed_at": "2026-10-07T12:04:30.000Z",
"comment": "Copy of web-frontend",
"kvm_note": "KVM could not be applied while the copy was running, so the copy was created with KVM off. Enable it later on the stopped copy.",
"copy_firewall_rules": true,
"copy_network_rules": true,
"operation_id": "9f86d081884c7d659a2feaa0c55ad015",
"created_at": "2026-10-07T12:04:00.000Z",
"updated_at": "2026-10-07T12:04:00.000Z",
"realm_ids": []
}
}

The 201 body carries the new computer in data.

FieldTypeDescription
statusCodenumberHTTP status code.
messagestringSummary of the outcome.
dataobjectThe new computer.
data.idstringIdentifier of the new computer.
data.namestringName of the new computer.
data.statusstringCurrent status: creating, running, paused, stopped, failed, deleted, copying, deleting, claiming or host_reinstalled.
data.source_computer_idstringIdentifier of the computer that was copied.
data.project_idstringIdentifier of the project that holds the copy.
data.project_aliasstring, nullableProject alias as a helper field.
data.server_idstring, nullableIdentifier of the server that hosts the copy.
data.server_namestring, nullableName of the server that hosts the copy.
data.subserver_namestringName of the subserver that hosts the copy.
data.ssh_hostnamestring, nullableSSH connection hostname, computed from project, computer and server.
data.colorstringColor of the computer.
data.computer_imagestringImage the computer runs.
data.aibooleanWhether AI features are enabled.
data.hoody_kitbooleanWhether the hoody_kit toolkit is installed in the computer.
data.dev_kitbooleanWhether dev_kit development tools are enabled.
data.kvmbooleanWhether /dev/kvm passthrough (hardware virtualization for running full VMs inside the computer) is enabled. Rented or dedicated (bare-metal) servers only; never free tier.
data.autostartbooleanWhether the computer starts automatically on host boot.
data.ramdisk_scopestringSharing scope for /ramdisk: computer (default) mounts only private storage, project additionally mounts /ramdisk/project, shared with your other computers in this project on the same server. Refused when the project has other members.
data.ramdiskbooleanWhether a ramdisk is mounted at /ramdisk. Backed by a shared per-server memory pool. Data survives computer restarts but is lost on a host reboot. Counts against memory, not disk.
data.is_defaultbooleanTrue if this is the user’s auto-provisioned default computer. Exactly one computer per user has this flag after signup.
data.computer_image_idstring, nullableIdentifier of the image the computer runs.
data.environment_varsobjectEnvironment variables of the computer.
data.volumesobjectVolumes attached to the computer.
data.ssh_public_keystring, nullableSSH public key installed in the computer.
data.ssh_key_fingerprintstring, nullableOpenSSH-format fingerprint (SHA256:…) of the installed key, the same string ssh-keygen -lf prints. Null when no key is installed.
data.ssh_key_installed_atstring, nullableWhen the currently installed key was set or last replaced (ISO 8601). Null when no key is installed, or briefly while a just-made key change is still settling.
data.commentstring, nullableFree-text comment.
data.kvm_notestringPresent when a copy-time kvm: true has an outcome to report, for example when KVM could not be enabled during the copy and the copy was created with KVM off. Absent when kvm: true was not requested or KVM was enabled.
data.copy_firewall_rulesbooleanWhether firewall rules will be copied from source to target.
data.copy_network_rulesbooleanWhether network rules and settings will be copied from source to target.
data.operation_idstringIdentifier of this operation. The computer.operation.completed or computer.operation.failed event that reports its outcome carries the same value in operation_id.
data.created_atstringCreation time (ISO 8601).
data.updated_atstringLast update time (ISO 8601).
data.realm_idsarray of stringsRealm IDs this computer belongs to.

POST /api/v1/computers/{id}/sync

Syncing a copy with its source is not available yet. A request that passes the usual checks, meaning the computer exists and was created by copying, the caller may update it and read its source, and neither is in a state that refuses a sync, is refused with 409 COMPUTER_SYNC_UNAVAILABLE, and the computer is left as it was. To get the source’s latest files, copy the source computer again.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to sync (must have been created via copy).

This endpoint accepts no request body.

Terminal window
curl -X POST "https://api.hoody.com/api/v1/computers/890abcdef12345678901cdef/sync" \
-H "Authorization: Bearer $HOODY_TOKEN"

Every error response carries statusCode (number), error (string) and message (string), plus data with additional error details when the error carries any.

Media type: application/json

Syncing a copy is not available yet, so this status is not returned while that holds: every request that passes the endpoint’s checks is refused with 409 COMPUTER_SYNC_UNAVAILABLE.

{
"statusCode": 200,
"message": "Computer sync initiated successfully",
"data": {
"computer_id": "890abcdef12345678901cdef",
"source_computer_id": "4501a2b3c4d5e6f7a8b9c0d1",
"status": "copying",
"operation_id": "9f86d081884c7d659a2feaa0c55ad015"
}
}

The 200 body carries the sync operation in data.

FieldTypeDescription
statusCodenumberHTTP status code.
messagestringSummary of the outcome.
dataobjectThe sync operation.
data.computer_idstringIdentifier of the computer that was synced.
data.source_computer_idstringIdentifier of the computer it was copied from.
data.statusstringCurrent status of the computer.
data.operation_idstringIdentifier of this operation. The computer.operation.completed or computer.operation.failed event that reports its outcome carries the same value in operation_id.