Error codes

Every error response carries a machine-readable code. Branch on it: the wording of title may change, the code does not.

HTTP 400 The request could not be read.

• invalid_json The request body could not be parsed as JSON.
• invalid_task_id The task id is not in the expected form.

HTTP 401 Authentication problem.

• invalid_token An Authorization header was present, but the token in it is not one we accept: unknown, revoked, or past its expiry date.
• token_expired The token you sent was valid once, but the expiry date chosen when it was issued has passed.
• unauthorized The request carried no usable credentials: the Authorization header was missing, or it did not use the Bearer scheme.

HTTP 402 Payment problem on the account.

• card_verification_required Creating a paid resource is refused because the owner of this project has no payment card linked.
• client_has_debt The project is still running, but the owner of the project has an invoice past its due date.
• email_verification_required The account that owns the project has not confirmed its email address, and paid resources are not created until it does.
• service_suspended The project is suspended for non-payment, so no new resource is created.

HTTP 403 Permission problem.

• insufficient_privileges Your token was issued to a team member rather than to the project owner, and the grant that member holds does not include this operation.
• insufficient_scope Your token is read-only and this request writes.

HTTP 404 Nothing here by that identifier.

• backup_not_found The backup id in the path is not a backup of this server.
• disk_not_found The disk id in the path is not a slot on this server.
• gpu_model_not_found One of the card models you named is not offered on this server type, or is no longer sold.
• gpu_package_not_found The GPU package you named does not exist on this server type, or is no longer sold.
• image_not_found The image identifier is not one this project can use here.
• interface_not_found The network interface named in the path is not on this server.
• ip_not_found The public IP address id is not one this project can use for this operation.
• network_not_found The network id is not one of this project's private networks - it does not exist, it was deleted, or it belongs to another project.
• not_found The path is not an endpoint of this API - a typo, a missing /v1 prefix, or an identifier whose shape does not match that resource.
• plan_not_found The plan_id you sent is not a plan of the server type in question.
• router_rule_not_found No rule or port forward with this number exists on the router.
• server_not_found The server id is not a server of this project.
• server_type_not_found The server type id is not one your project may use here.
• ssh_key_not_found The SSH key id does not belong to the account that owns this project - it was never added, it has already been deleted, or it belongs to another customer.
• task_not_found The task id is not a task of this project - it was never issued, or it belongs to another project.
• vpn_device_not_found No device with this identifier exists on this tunnel.

HTTP 405 Wrong method for this path.

• method_not_allowed The path exists but does not support this HTTP method.

HTTP 409 The request is valid, the current state is not.

• backup_not_ready You asked to restore a server from a backup that is not a finished archive.
• backup_schedule_exists You asked to put a backup schedule on a server that already has one.
• backups_disabled You asked to take a backup of a server whose backups are switched off.
• disk_locked You asked to resize or delete a disk that a snapshot still holds.
• firewall_changed_concurrently The firewall of this server changed while your request was running - either somebody edited it in the control panel, or the platform did not finish moving a rule your request had just created.
• firewall_no_public_iface You asked to switch the firewall on for a server that has no public network interface.
• firewall_rules_unsupported This server carries firewall rules that this API cannot express, so replacing the set would silently change what they do.
• idempotency_in_progress An earlier request carrying this `Idempotency-Key` is still running, so this one was not executed at all.
• image_in_use You asked to delete an image that is currently inserted into one of your servers.
• image_limit_reached The project already holds as many images as it may - three, counted separately for ISO images and for server images.
• image_not_mounted You asked to eject an image and the platform found nothing inserted in the server's drive.
• image_url_add_disabled This project accepts images only as directly uploaded files, and this API adds images by their address.
• interface_management_disabled Network interface management is switched off for this project, or the single field you sent (`firewall`, `link_down`) is not manageable for it.
• interface_not_removable You asked to delete `net0`, the interface the server was created with.
• ip_in_use The public IP address is attached to a server.
• iso_mounted You asked to delete a disk while an image is inserted into the server's drive.
• network_has_no_router You asked to unlink a router from a network that has none linked.
• network_has_router A router is already linked to this network, and you asked for something that requires none: linking a second router, creating a router in it, or changing or deleting the network while the router holds its subnet.
• network_in_use Servers are still attached to this network, and you asked to delete it or to change its subnet.
• network_is_default You asked to delete the project's default network.
• network_name_taken Another network in this project already carries this name.
• network_not_configured The network in this request has no subnet assigned, so a router attached to it could not hand out addresses.
• no_gpu_capacity The platform has nothing free that fits the request.
• quota_exceeded This project has reached the ceiling set for the resource you are creating: servers, public IP addresses, data disks on one server, or private networks.
• rebuild_disabled Reinstalling the operating system is switched off for this project.
• rebuild_image_unavailable The image this server was installed from no longer exists, so there is nothing to reinstall it from.
• router_base_network You tried to detach the first private network from a router.
• router_credentials_forbidden You asked to change the administrator password or install SSH keys on a router.
• router_firewall_forbidden You addressed the platform firewall to a router.
• router_image_forbidden You tried to create an image from a router.
• router_interface_forbidden You tried to add, change, or remove a network interface on a router.
• router_interface_not_found The router has no interface with the name you gave.
• router_iso_forbidden You tried to insert or eject an image in a router's drive.
• router_no_free_interfaces Every network slot on this router is already in use, so there is nowhere to attach another network.
• router_not_configured The router is missing something the platform needs in order to reach it: a public IP address, or a management key on record.
• router_not_running The router is powered off.
• router_port_reserved The public port of the forward covers the port the platform uses to manage the router.
• router_port_vpn The public port of the forward covers the port of the router's WireGuard or OpenVPN tunnel, including a tunnel that is currently switched off.
• router_rename_forbidden You sent a name for a router.
• router_rule_limit_reached Every rule number the platform may hand out on this router is taken.
• router_rule_not_editable The rule carries conditions this API cannot express - it was written by hand inside the router.
• router_rule_taken A rule with the priority you asked for already exists on the router.
• router_scale_forbidden The platform refuses to move a router onto a different plan: a router's size comes from its image and is not adjustable afterwards.
• router_target_is_router The target address belongs to the router itself.
• router_target_not_in_network The target address is not inside any private network attached to this router.
• server_busy Another operation on this server is already running or is being submitted at this moment - a create, a reinstall, a backup, a disk or plan change, or a second request of your own.
• server_not_stopped Changing the plan requires the server to be powered off, and this one is running.
• service_provisioning Your token is valid, but the project behind it is still being set up and does not accept operations yet.
• ssh_key_limit_exceeded The keys you sent, added to the keys already installed on this server, would exceed the limit of 20 keys per server.
• ssh_key_name_taken You already have a key with this name and different key material.
• system_disk_not_found You asked to resize the system disk, but this server has no bootable system disk right now.
• tag_limit_reached This server already carries the maximum number of tags (10), so the new one was not added.
• vpn_conflict The port or the subnet recorded for this tunnel is now used by another interface on the router, so the tunnel cannot be brought back as recorded.
• vpn_device_limit_reached The tunnel already has the maximum number of devices (ten).
• vpn_device_not_editable The peer was added inside the router by hand, not through the platform, so there is no device record to rename.
• vpn_key_exists A device with this public key already exists on the tunnel, on the platform or on the router itself.
• vpn_no_capacity The router has no free interface name, port or subnet in the band the platform reserves for tunnels.
• vpn_not_enabled The tunnel is switched off or was never switched on, so there is nothing to add a device to.
• vpn_unmanaged The tunnel interface on the router does not match what the platform has on record: it was changed inside the router by hand (the key replaced, a second marked interface added, the subnet changed).

HTTP 413 The request body is too large.

• payload_too_large The request body is larger than 256 KB.

HTTP 415 Wrong content type.

• unsupported_media_type The request has a body, but its Content-Type is not application/json - most often a form-encoded body produced by an HTTP client's default form helper.

HTTP 422 The request did not pass validation.

• conflicting_changes You asked for more than one resource change in a single server update, or combined a name change with one of them.
• credentials_required You created a server without a password and without any SSH keys.
• disk_is_system The disk you addressed is the server's system disk.
• disk_not_extendable The platform refused to resize the addressed disk because it is not a data disk.
• disk_shrink_not_allowed The size_gb you sent is smaller than or equal to the disk's current size.
• disk_type_not_available The storage you asked for does not exist on this server type.
• disk_type_not_supported You sent disk_type to a server type where the storage class of the system disk is part of the type.
• gpu_count_exceeded The cards you asked for add up to more than one server of this type may hold.
• gpu_package_not_supported You sent gpu_package to a server type that is not sold as a GPU package.
• gpu_package_required You are creating a server on a type sold as a GPU package, and the request named no package.
• gpus_not_supported You sent gpus to a server type that has no graphics cards to pick from.
• gpus_required You are creating a server on a type that is sold with graphics cards, and the request named no cards.
• granularity_too_fine The window you asked for, split at the requested granularity, would produce more than 750 buckets.
• idempotency_key_reused This Idempotency-Key is already held by a different request.
• image_minimum_not_met The image you chose declares minimum cores, memory or disk, and the request asked for less than one of them.
• image_not_supported You asked to create a server from one of your own uploaded ISO images.
• interface_ips_not_allowed You sent ips for an interface that is private, or that this request would make private.
• interface_limit_exceeded The server already has ten network interfaces, the maximum, so another one cannot be added.
• invalid_cidr The subnet you sent is not a usable network address.
• invalid_firewall_rule One rule in the set was rejected.
• invalid_hostname The platform did not accept the name you asked for on the server.
• invalid_idempotency_key The Idempotency-Key header itself is malformed.
• invalid_image_description The description is longer than 1000 characters, or it contains an angle bracket (< or >).
• invalid_image_name The image name is empty, longer than 50 characters, or contains characters that are not allowed.
• invalid_image_url The url is missing, does not begin with http or https, or is not a well-formed URL.
• invalid_memory memory_mb is not a whole number of gigabytes.
• invalid_name The name was rejected: it is empty, too long, or contains characters that are not allowed.
• invalid_password The administrator password in the request does not meet the platform policy: Latin letters and digits only, and at least one uppercase letter, one lowercase letter and one digit.
• invalid_public_key The public key is not a canonical WireGuard key: 32 bytes encoded as 44 characters of base64.
• invalid_request The request body failed validation: an unknown field, a missing required field, a value of the wrong type or outside the allowed range, a body that is not a JSON object, or a body sent to an endpoint that takes none.
• invalid_router_rule The router rule or port forward was rejected on its content: an unknown action or protocol, a port without a tcp or udp protocol, a malformed address, port or port range, a description that is too long or carries control characters, or a target that is not an IPv4 address.
• invalid_rule_number The priority is outside the band 2000 to 999000, or is not a whole number.
• invalid_ssh_key The public key material you sent is not a valid OpenSSH public key.
• invalid_tag The tag is empty, too long, contains characters that cannot occur in a stored tag (control characters or a slash), or begins with the reserved hb- prefix that the platform keeps for its own markers.
• license_not_accepted The image carries a paid Microsoft licence and the request did not accept the SPLA terms.
• name_required You are creating a server from an ordinary image and the body has no name.
• network_required The server you are creating would have no network interface at all: the request carries neither public_ipv4 nor any entry in networks.
• nic_ips_on_create_not_supported You sent ips while CREATING a network card.
• not_a_router A router-only operation was addressed to a server that is not a router - DHCP settings, the router API key, the router firewall, port forwards or the external address.
• plan_downgrade_not_allowed The plan you asked for is smaller than the server's current size in at least one of cores, memory or disk.
• plan_not_supported You sent plan_id to a server type that has no plans.
• plan_required You are creating a server on a server type that sells ready-made plans, and the body has no plan_id.
• rebuild_password_not_supported You asked to reinstall a server that boots from installer media and sent a password with the request.
• resource_limit_exceeded The cores, memory or disk size in the request is above the maximum this server type allows.
• resources_managed_by_package You sent cores, memory_mb, disk_gb or plan_id to a server type sold as a GPU package, or asked to add or grow a disk on such a server.
• resources_managed_by_plan You sent cores, memory_mb or disk_gb to a server type where the size is defined by the plan.
• router_field_not_supported A create request using a router image carried a field the platform sets itself: name, cores, memory_mb, disk_gb, plan_id, password, ssh_keys, setup or accept_license.
• router_network_required A create request using a router image did not carry exactly one private network in networks - either none at all, or more than one.
• router_public_ip_required A create request using a router image had no public_ipv4.
• server_type_not_supported The operation does not apply to this server type, or to a router.
• setup_field_required The image you are deploying is a marketplace application with mandatory setup fields, and the setup object in your request left one of them out.
• too_many_interfaces The server being created would end up with more than ten network interfaces once the public address and every requested private network are counted.
• window_too_large The cost window you asked for on GET /v1/project/costs is wider than 400 days.

HTTP 429 Too many requests.

• rate_limited You have exceeded the per-token allowance for the current minute: 60 reads or 20 writes.

HTTP 500 Something failed unexpectedly on our side.

• internal_error Something failed on our side while handling a request that was itself valid.

HTTP 503 The request is valid, we could not complete it.

• backup_create_failed Your request is correct, but the platform did not accept the backup job for this server.
• backup_delete_failed The backup exists and belongs to this server, but the platform did not accept the removal job.
• backup_list_unavailable The backup list is read from storage on every request, and this time the scan either failed or did not finish in time.
• backup_policy_apply_failed The platform did not finish applying the backup policy: after the write, the policy read back does not match what you asked for.
• backup_restore_failed The backup is a finished archive and belongs to this server, but the platform did not accept the restore job.
• costs_unavailable The cost figures for this project could not be read.
• events_unavailable The server exists and belongs to you, but its event history could not be read.
• firewall_apply_failed The platform refused part of the firewall change: setting the options, creating a rule, or removing an old rule failed.
• firewall_unavailable The firewall of this server cannot be read right now.
• image_delete_failed The image exists in your project and, for an ISO, is not inserted into any server, but the platform did not accept the removal.
• image_eject_failed The platform did not eject the image from this server.
• image_limit_unreadable The image limit of your project could not be read, so the request was not attempted.
• image_list_unavailable The image list is read from storage, and this time the storage did not answer.
• image_mount_failed The image you named is one this server accepts, but the platform did not insert it.
• ip_list_unavailable The list of the project's public addresses is read on every request that needs it, and this time the platform did not answer.
• metrics_unavailable The metrics source did not answer for this server, or it answered with something that is not a series.
• network_config_unavailable The network interfaces of this server could not be read.
• no_free_ips There is no free public IPv4 address left in the pool that serves this server type.
• password_reset_failed The platform did not accept the password change for this server.
• platform_disabled The public API is switched off, or it is in read-only mode and this request writes.
• router_apply_failed The router refused to apply the change, or did not answer while applying it.
• router_unreachable The router did not answer on its management interface.
• server_unavailable The server could not be read or reached right now.
• ssh_key_install_failed The keys you named exist in the project and stay within the per-server limit, but the platform did not accept the installation.
• storage_content_unavailable The disk configuration of this server could not be read.
• submission_failed The request was not handed to the platform, or it was cut off before the platform answered.
• vpn_revoke_pending The device was removed from the platform, but the router did not accept the certificate revocation, so it still accepts that certificate.