# Computer Copy & Sync **Page:** api/computer-copy-sync [Download Raw Markdown](./api/computer-copy-sync.md) --- # Computer Copy & Sync 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. ## Copy a computer `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. A copy never inherits the source computer's `/dev/kvm` passthrough. `kvm: true` is granted only on rented or dedicated targets, and a request for any other target is refused with 403. When a grant cannot be applied synchronously, the copy is created with KVM off and the response reports the outcome in `kvm_note`. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | string | Yes | Unique identifier of the source computer to copy. | ### Request body | Name | Type | Required | Description | | --- | --- | --- | --- | | `target_project_id` | string | Yes | ID of the project where the copy will be created. A 24-character hexadecimal string. | | `target_server_id` | string | No | ID of the server where the copy will be created. Defaults to the source server. A 24-character hexadecimal string. | | `name` | string | No | Name for the copied computer, auto-generated if not provided. 3 to 100 characters, letters, digits, `-` and `_` only. | | `ssh_public_key` | string, nullable | No | SSH public key for the copied computer. It must be unique and is not inherited from the source. | | `source_snapshot` | string | No | Specific 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_rules` | boolean | No | Whether to copy firewall rules from the source computer to the target computer. Default: `false`. | | `copy_network_rules` | boolean | No | Whether to copy network rules and settings from the source computer to the target computer. Default: `false`. | | `kvm` | boolean | No | Grant 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_kvm` | boolean | No | Accepted alias of `kvm` on input. `kvm` wins if both are sent, and they must agree. | ```json { "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 } ``` ### Example request ```bash 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 }' ``` ```typescript import { HoodyClient } from 'hoody-sdk'; const client = new HoodyClient({ baseURL: 'https://api.hoody.com', token: process.env.HOODY_TOKEN }); const copy = await client.api.computers.copy('4501a2b3c4d5e6f7a8b9c0d1', { 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 }); ``` ### Responses 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. ```json { "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": [] } } ``` Media type: `application/json` ```json { "statusCode": 400, "error": "Bad Request", "message": "Invalid ssh_public_key" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `Bad Request` | Invalid input parameters | Cause: `VALIDATION_ERROR`. One or more request parameters passed the schema but failed a check of this operation, for example two fields that must agree or a name that must exist. The message names the problem. A request that does not match the schema is answered with 422 `Validation Error` instead. | Correct the value the message names, then send the request again. | | `SERVER_COMPUTER_LIMIT` | Server computer limit reached | The target server is at its maximum number of computers (explicit `max_computers`, or the free-tier default). Stopped computers count; failed, deleted and deleting ones do not. When more computers can be bought, `data.upgrade` says how: `{"kind":"buy_paid_subserver"}` on a free server, `{"kind":"upgrade_subscription","subscription_id":""}` on a paid subserver whose plan can grow. | Delete a computer on this server (stopped ones count too), or upgrade: buy a paid subserver, or upgrade the subscription named in `data.upgrade`. | | `PROJECT_COMPUTER_LIMIT` | Project computer limit reached | The target project is at its owner-configured computer quota (the project's `max_computers` setting). | Delete an existing computer in this project, raise the project quota, or use a different project. | | `REALM_LIMIT_REACHED` | Realm limit reached | The change would add a realm the account does not use yet, and the account already uses as many realms as its limit allows. A realm is in use while one of your projects or computers carries it. `data.max` is the limit and `data.used` the realms in use. Nothing was changed. `data.used` is omitted for a token limited to realms (it counts every realm of the account). | Use a realm the account already has, remove a realm from every project and computer that carries it, or move to a higher limit: accounts that have held a paid server or rented a bare-metal server get more realms. GET /api/v1/realms shows the limit and the count under `cap`. | | `UPGRADE_REQUIRED` | Request uses a retired name | The request uses a name this API no longer accepts, or comes from a Hoody CLI too old for this API. Nothing was changed. | Send the name in `data.renamed[].to`, or update the Hoody CLI and SDK (`npm i -g hoody-sdk`). | Catalogue error codes: `VALIDATION_ERROR`. Media type: `application/json` ```json { "statusCode": 401, "error": "MISSING_TOKEN", "message": "Authorization header is required" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `MISSING_TOKEN` | Authentication token missing | The request carries no Authorization header, or the header holds no token | Send an Authorization header as `Bearer ` with a sign-in token or an auth token | | `INVALID_TOKEN` | Invalid authentication token | The provided authentication token is malformed or invalid | Obtain a new token by logging in again or using a valid auth token | | `TOKEN_EXPIRED` | Authentication token expired | The sign-in token (JWT) has expired. An expired auth token is refused with `INVALID_TOKEN` instead. | Sign in again, or refresh the session. | | `AUTH_TOKEN_LINEAGE_REVOKED` | Parent auth token no longer valid | The auth token was created by another auth token, and that token (or one above it) has been revoked, disabled or has expired, so this one no longer authenticates | Create a new auth token from a valid one, or sign in again | | `INVALID_CREDENTIALS` | Invalid credentials | The provided username/email or password is incorrect | Verify your credentials and try again, or use the password reset feature | | `EMAIL_NOT_VERIFIED` | Email not verified | The password is correct but the account's email address is not verified yet. It is only returned after the password has been checked. On the login endpoint the response carries `data.email`, so the client can offer to resend the verification link. HTTP Basic authentication returns it on any operation, without the email. | Complete email verification by clicking the link sent to your inbox, or call `POST /api/v1/auth/resend-verification` to receive a new link, or complete a password reset, which also verifies the email. | | `INVALID_OTP_CODE` | Invalid OTP code | The provided 2FA code is incorrect or has expired | Generate a new code from your authenticator app and try again | Media type: `application/json` ```json { "statusCode": 403, "error": "INSUFFICIENT_PERMISSIONS", "message": "Insufficient permissions" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `INSUFFICIENT_PERMISSIONS` | Insufficient permissions | You do not have the required permissions to perform this action | Ask the resource owner to grant you access | | `ACCOUNT_BANNED` | Account banned | Your account has been banned and cannot access this resource | Contact support for information about your account status | Media type: `application/json` A missing computer is answered with the wire error `Not Found` and a message of the form `Computer with ID not found`. ```json { "statusCode": 404, "error": "Not Found", "message": "Computer with ID 4501a2b3c4d5e6f7a8b9c0d1 not found" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `Not Found` | Source computer not found | Cause: `SOURCE_COMPUTER_NOT_FOUND`. The source computer specified for a copy or sync operation does not exist. | Verify the source computer ID is correct. | | `Not Found` | Resource not found | Cause: `RESOURCE_NOT_FOUND`. The requested resource does not exist or has been deleted. | Verify the resource ID and ensure it exists. | Catalogue error codes: `SOURCE_COMPUTER_NOT_FOUND`, `RESOURCE_NOT_FOUND`. Media type: `application/json` ```json { "statusCode": 409, "error": "COMPUTER_NAME_IN_USE", "message": "Computer name already in use within the project" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `COMPUTER_NAME_IN_USE` | Computer name already in use | A computer with this name already exists in the project. `data.computer_id` names it and `data.status` gives its status when you can see it; `data.status` is `creating` while it is still being set up. | If it is the computer you meant to create, use it. Otherwise choose a different name. | | `SSH_PUBLIC_KEY_IN_USE` | SSH public key already in use | SSH public keys must be unique per computer. A single public key cannot be assigned to multiple computers. | Generate a new SSH key pair for this computer, or remove the key from the other computer before reusing it. | | `OPERATION_STATE_CONFLICT` | Computer State Conflict | The operation cannot be performed because the computer is not in the correct state. | Check the computer's current status and retry once it allows the operation. | | `COMPUTER_NETWORK_POLICY_MISSING` | Computer network policy not in force | The computer has no network policy in force (a copy whose source network settings could not be applied), so it cannot be copied, synced from, restored, or set to start automatically. Nothing was changed. | Configure the computer's network first (`PUT /api/v1/computers/{id}/network`), then retry. | | `SERVER_DELETION_IN_PROGRESS` | Target server is being deleted | The server the computer would be placed on is being deleted. Nothing was created. | Retry once the deletion has finished, or choose another server. | | `PROJECT_SHARE_REVOKE_IN_PROGRESS` | Storage share being removed | A storage share of this project is being removed and is recording which computers use it. Until that finishes (seconds to a few minutes), no computer can join or leave the project, and a computer the removal names cannot move. | Retry in a few seconds. | | `TARGET_SERVER_UNAVAILABLE` | Target server no longer available | The server the computer was placed on went away before the computer was set up. The computer was not created. | Retry the create. | | `COMPUTER_OPERATION_IN_PROGRESS` | Another operation is running on this computer | Another start, stop, setup or maintenance operation is already in progress on this computer. Nothing was done. | Retry in a few seconds. | | `KVM_NOT_AVAILABLE` | KVM not available on this server | KVM needs dedicated hardware that supports it, and this server does not provide it. Nothing was changed. | Use a server with dedicated hardware, or contact support. | | `KVM_HOST_UPGRADE_REQUIRED` | Server does not support KVM yet | The server must be upgraded before KVM can be enabled on it. Nothing was changed. | Retry after the server has been upgraded, or contact support. | | `KVM_CHANGE_IN_PROGRESS` | Another KVM change is running | Another KVM change is in progress on this server. Nothing was changed. | Retry shortly. | | `SERVER_BUSY` | Server busy | Another change is running on this server, so this request was refused. A refused create or copy changed nothing; a refused server delete leaves the server closed to new paid sales. | Retry shortly. A create or copy can also choose another server. | | `SUBSERVER_OWNER_MISMATCH` | Subserver has another owner | A subserver has exactly one owner, and every computer on it must belong to that owner. The computer would belong to someone else, or the subserver still holds another user's computers. Nothing was changed. | Place the computer on a server its owner may use, or move or delete the other user's computers first. | Media type: `application/json` The request does not match the operation schema, or its JSON body cannot be parsed. `data` carries the validator's failing checks. ```json { "statusCode": 422, "error": "Validation Error", "message": "Validation failed: /name must NOT have fewer than 3 characters", "data": [ { "instancePath": "/name", "schemaPath": "#/properties/name/minLength", "keyword": "minLength", "params": { "limit": 3 }, "message": "must NOT have fewer than 3 characters" } ] } ``` Media type: `application/json` ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Rate limit exceeded for this endpoint. Please try again later." } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `Too Many Requests` | Rate limit exceeded | Cause: `RATE_LIMIT_EXCEEDED`. Too many requests of this kind in a short time, counted per account, auth token or address. The request was not carried out. | Wait the number of seconds in the Retry-After header, then try again. | Catalogue error codes: `RATE_LIMIT_EXCEEDED`. Media type: `application/json` The copy failed. With the code `COMPUTER_COPY_DISPATCH_FAILED` the copy was never handed to the server and nothing was created. Any other 500 is ambiguous: the copy may have started, so check the target computer before retrying. ```json { "statusCode": 500, "error": "COMPUTER_COPY_DISPATCH_FAILED", "message": "Computer copy could not be started on its host" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `COMPUTER_COPY_DISPATCH_FAILED` | Computer copy could not be started | The copy request could not be sent to the server, so no copy was created. Its name, SSH key and quota slot are free again. | Retry the request. If it keeps failing, try another target server or contact support. | Media type: `application/json` The server could not be reached before anything was sent. Nothing was created, so retry after the `Retry-After` header. ```json { "statusCode": 503, "error": "COMPUTER_HOST_UNAVAILABLE", "message": "The server for this computer could not be reached right now. Nothing was created. Retry shortly." } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `COMPUTER_HOST_UNAVAILABLE` | Computer server temporarily unavailable | The server for this computer could not be reached for a moment, so the create or copy request was never sent and nothing was created. Its name, SSH key and quota slot are free again. | Retry after the number of seconds in the `Retry-After` header. | ### Response fields The 201 body carries the new computer in `data`. | Field | Type | Description | | --- | --- | --- | | `statusCode` | number | HTTP status code. | | `message` | string | Summary of the outcome. | | `data` | object | The new computer. | | `data.id` | string | Identifier of the new computer. | | `data.name` | string | Name of the new computer. | | `data.status` | string | Current status: `creating`, `running`, `paused`, `stopped`, `failed`, `deleted`, `copying`, `deleting`, `claiming` or `host_reinstalled`. | | `data.source_computer_id` | string | Identifier of the computer that was copied. | | `data.project_id` | string | Identifier of the project that holds the copy. | | `data.project_alias` | string, nullable | Project alias as a helper field. | | `data.server_id` | string, nullable | Identifier of the server that hosts the copy. | | `data.server_name` | string, nullable | Name of the server that hosts the copy. | | `data.subserver_name` | string | Name of the subserver that hosts the copy. | | `data.ssh_hostname` | string, nullable | SSH connection hostname, computed from project, computer and server. | | `data.color` | string | Color of the computer. | | `data.computer_image` | string | Image the computer runs. | | `data.ai` | boolean | Whether AI features are enabled. | | `data.hoody_kit` | boolean | Whether the `hoody_kit` toolkit is installed in the computer. | | `data.dev_kit` | boolean | Whether `dev_kit` development tools are enabled. | | `data.kvm` | boolean | Whether `/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.autostart` | boolean | Whether the computer starts automatically on host boot. | | `data.ramdisk_scope` | string | Sharing 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.ramdisk` | boolean | Whether 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_default` | boolean | True if this is the user's auto-provisioned default computer. Exactly one computer per user has this flag after signup. | | `data.computer_image_id` | string, nullable | Identifier of the image the computer runs. | | `data.environment_vars` | object | Environment variables of the computer. | | `data.volumes` | object | Volumes attached to the computer. | | `data.ssh_public_key` | string, nullable | SSH public key installed in the computer. | | `data.ssh_key_fingerprint` | string, nullable | OpenSSH-format fingerprint (SHA256:...) of the installed key, the same string `ssh-keygen -lf` prints. Null when no key is installed. | | `data.ssh_key_installed_at` | string, nullable | When 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.comment` | string, nullable | Free-text comment. | | `data.kvm_note` | string | Present 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_rules` | boolean | Whether firewall rules will be copied from source to target. | | `data.copy_network_rules` | boolean | Whether network rules and settings will be copied from source to target. | | `data.operation_id` | string | Identifier 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_at` | string | Creation time (ISO 8601). | | `data.updated_at` | string | Last update time (ISO 8601). | | `data.realm_ids` | array of strings | Realm IDs this computer belongs to. | ## Sync a copied computer `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. Every sync request that passes the endpoint's checks ends in 409 `COMPUTER_SYNC_UNAVAILABLE`. Call `POST /api/v1/computers/{id}/copy` on the source computer to obtain a copy with the latest files. ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `id` | path | string | Yes | Unique identifier of the computer to sync (must have been created via copy). | This endpoint accepts no request body. ### Example request ```bash curl -X POST "https://api.hoody.com/api/v1/computers/890abcdef12345678901cdef/sync" \ -H "Authorization: Bearer $HOODY_TOKEN" ``` ```typescript import { HoodyClient } from 'hoody-sdk'; const client = new HoodyClient({ baseURL: 'https://api.hoody.com', token: process.env.HOODY_TOKEN }); const sync = await client.api.computers.sync('890abcdef12345678901cdef'); ``` ### Responses 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`. ```json { "statusCode": 200, "message": "Computer sync initiated successfully", "data": { "computer_id": "890abcdef12345678901cdef", "source_computer_id": "4501a2b3c4d5e6f7a8b9c0d1", "status": "copying", "operation_id": "9f86d081884c7d659a2feaa0c55ad015" } } ``` Media type: `application/json` ```json { "statusCode": 400, "error": "UPGRADE_REQUIRED", "message": "This Hoody CLI is too old for the renamed API. Update: npm i -g hoody-sdk@1.0.1" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `UPGRADE_REQUIRED` | Hoody CLI too old | The request comes from a Hoody CLI too old for this API. Nothing was changed. | Update the Hoody CLI and SDK (`npm i -g hoody-sdk`). | Media type: `application/json` ```json { "statusCode": 401, "error": "MISSING_TOKEN", "message": "Authorization header is required" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `MISSING_TOKEN` | Authentication token missing | The request carries no Authorization header, or the header holds no token | Send an Authorization header as `Bearer ` with a sign-in token or an auth token | | `INVALID_TOKEN` | Invalid authentication token | The provided authentication token is malformed or invalid | Obtain a new token by logging in again or using a valid auth token | | `TOKEN_EXPIRED` | Authentication token expired | The sign-in token (JWT) has expired. An expired auth token is refused with `INVALID_TOKEN` instead. | Sign in again, or refresh the session. | | `AUTH_TOKEN_LINEAGE_REVOKED` | Parent auth token no longer valid | The auth token was created by another auth token, and that token (or one above it) has been revoked, disabled or has expired, so this one no longer authenticates | Create a new auth token from a valid one, or sign in again | | `INVALID_CREDENTIALS` | Invalid credentials | The provided username/email or password is incorrect | Verify your credentials and try again, or use the password reset feature | | `EMAIL_NOT_VERIFIED` | Email not verified | The password is correct but the account's email address is not verified yet. It is only returned after the password has been checked. On the login endpoint the response carries `data.email`, so the client can offer to resend the verification link. HTTP Basic authentication returns it on any operation, without the email. | Complete email verification by clicking the link sent to your inbox, or call `POST /api/v1/auth/resend-verification` to receive a new link, or complete a password reset, which also verifies the email. | | `INVALID_OTP_CODE` | Invalid OTP code | The provided 2FA code is incorrect or has expired | Generate a new code from your authenticator app and try again | Media type: `application/json` ```json { "statusCode": 403, "error": "INSUFFICIENT_PERMISSIONS", "message": "Insufficient permissions" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `INSUFFICIENT_PERMISSIONS` | Insufficient permissions | You do not have the required permissions to perform this action | Ask the resource owner to grant you access | | `ACCOUNT_BANNED` | Account banned | Your account has been banned and cannot access this resource | Contact support for information about your account status | Media type: `application/json` A missing computer is answered with the wire error `Not Found` and a message of the form `Computer with ID not found`. ```json { "statusCode": 404, "error": "Not Found", "message": "Computer with ID 890abcdef12345678901cdef not found" } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `Not Found` | Computer not found | Cause: `COMPUTER_NOT_FOUND`. The requested computer does not exist or you do not have permission to access it. | Verify the computer ID is correct and that you have access to the project it belongs to. | Catalogue error codes: `COMPUTER_NOT_FOUND`. Media type: `application/json` ```json { "statusCode": 409, "error": "COMPUTER_SYNC_UNAVAILABLE", "message": "Syncing a copy is not available yet. To get the source's latest files, copy the source again." } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `COMPUTER_NOT_COPIED` | Computer Not a Copy | The sync operation can only be performed on a computer that was created by copying another. | This operation is only valid for computers with a `source_computer_id`. | | `OPERATION_STATE_CONFLICT` | Computer State Conflict | The operation cannot be performed because the computer is not in the correct state. | Check the computer's current status and retry once it allows the operation. | | `COMPUTER_SYNC_UNAVAILABLE` | Computer sync unavailable | Syncing a copy is not available yet. The computer is left as it was. | Copy the source computer again to get its latest files. | | `COMPUTER_OPERATION_IN_PROGRESS` | Another operation is running on this computer | Another start, stop, setup or maintenance operation is already in progress on this computer. Nothing was done. | Retry in a few seconds. | | `COMPUTER_NETWORK_POLICY_MISSING` | Computer network policy not in force | The computer has no network policy in force (a copy whose source network settings could not be applied), so it cannot be copied, synced from, restored, or set to start automatically. Nothing was changed. | Configure the computer's network first (`PUT /api/v1/computers/{id}/network`), then retry. | Media type: `application/json` The request does not match the operation schema. A computer id that is not 24 lowercase hexadecimal characters is answered with this status, and `data` carries the failing checks. ```json { "statusCode": 422, "error": "Validation Error", "message": "Validation failed: /id must match pattern \"^[0-9a-f]{24}$\"", "data": [ { "instancePath": "/id", "schemaPath": "#/properties/id/pattern", "keyword": "pattern", "params": { "pattern": "^[0-9a-f]{24}$" }, "message": "must match pattern \"^[0-9a-f]{24}$\"" } ] } ``` Media type: `application/json` ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Rate limit exceeded for this endpoint. Please try again later." } ``` | Error Code | Title | Description | Resolution | | --- | --- | --- | --- | | `Too Many Requests` | Rate limit exceeded | Cause: `RATE_LIMIT_EXCEEDED`. Too many requests of this kind in a short time, counted per account, auth token or address. The request was not carried out. | Wait the number of seconds in the Retry-After header, then try again. | Catalogue error codes: `RATE_LIMIT_EXCEEDED`. ### Response fields The 200 body carries the sync operation in `data`. | Field | Type | Description | | --- | --- | --- | | `statusCode` | number | HTTP status code. | | `message` | string | Summary of the outcome. | | `data` | object | The sync operation. | | `data.computer_id` | string | Identifier of the computer that was synced. | | `data.source_computer_id` | string | Identifier of the computer it was copied from. | | `data.status` | string | Current status of the computer. | | `data.operation_id` | string | Identifier of this operation. The `computer.operation.completed` or `computer.operation.failed` event that reports its outcome carries the same value in `operation_id`. |