Error codes

Every error is application/problem+json (RFC 9457) with a stable code and a readable detail:

{ "status": 409, "code": "node_offline", "detail": "The node is offline." }

Program against code; detail may change.

Servers and files

Status	code	Meaning
400	invalid_action	the power action is not start, stop, restart or kill
400	variable_invalid, variable_unknown	a variable’s value breaks its rules, or the template has no such variable
400	limit_invalid	memory, CPU or disk below the minimum
400	range_invalid	metrics range not 1h, 6h, 24h or 7d
400	count_invalid	more than 20 servers at once, or fewer than 1
400	custom_ports_not_allowed, custom_ports_invalid	the game has fixed ports, or an extra port’s role is invalid or used twice
400	forward_target_ipv4	port forwards need an IPv4 address
400	backup_invalid	the uploaded file is not a .tar.gz
400	upload_out_of_order	an upload part’s offset doesn’t continue the upload
400	no_free_allocation	the node has no free port for a role
403	forbidden	the action or path isn’t allowed for you
403	path_outside	the path leaves the server’s files
403	token_not_allowed	API tokens can’t use this endpoint
404	not_found, server_not_found	unknown file or server, or no access at all
409	node_offline	the node’s agent isn’t connected
409	invalid_state	not possible in the server’s state, e.g. a command while it’s offline
409	disk_full	the write would go over the server’s disk limit
409	exists, is_directory	the target exists, or is a folder
409	backup_busy, backup_locked	the backup is in use, or locked
409	schedule_running	the schedule runs already
412	precondition_failed	If-Match / If-None-Match didn’t hold: the file changed

Accounts, tenants and nodes

Status	code
400	url_invalid, events_required, permissions_required, invalid_ip, invalid_ports, registry_invalid, template_invalid, invalid_code, email_unchanged, token_invalid
403	invalid_credentials, locked_out, tenant_creation_disabled, password_wrong, confirmation_wrong, setup_token_invalid, cross_origin
404	tenant_not_found, node_not_found, not_a_member, invitation_invalid
409	account_exists, already_member, last_owner, last_operator, last_sign_in_method, node_in_use, tenant_in_use, template_in_use, allocation_in_use, steam_account_in_use, ssh_key_exists, sole_owner, email_not_configured, master_key_required

Authentication failures (missing, invalid, revoked or expired token, or a token used from the wrong network) answer 401.