Skip to main content

Errors

Hyperstack uses standard HTTP status codes. 2xx means success. 4xx means the request was rejected; fix it and retry. 5xx means a Hyperstack-side issue; retry with backoff.

Error response shape

Every error response uses the same JSON envelope:

Error response
{
"status": false,
"message": "Insufficient balance to create the resource",
"error_reason": "bad_request"
}
FieldTypeDescription
statusbooleanfalse on error.
messagestringHuman-readable description of what went wrong.
error_reasonstringMachine-readable error category. See the table below.

A small number of responses omit error_reason, most often the legacy 5xx shape ({"message": "Internal Server Error"}) and some pre-validation 400 responses. Treat the missing-key case as bad_request.

Status codes

Codeerror_reasonWhen it occursFix
400bad_requestRequest body or parameters failed validation.Check the request against the endpoint spec.
401unauthorizedAPI key missing, malformed, or revoked.Generate a new API key and pass it as the api_key header. See Authentication.
403forbiddenKey lacks permission for the operation, or the resource belongs to a different environment.Check the key's scope. Some operations require elevated permissions.
404not_foundResource doesn't exist or isn't visible to this key. IDs are region-scoped: an ID from CANADA-1 isn't visible to a key scoped to NORWAY-1.Verify the ID with the corresponding List endpoint.
405not_allowedHTTP method not supported on this path.Check the spec for the correct method.
406(none)A query parameter value isn't acceptable.Check the parameter's allowed values in the spec.
409already_existA resource with the same identifying attribute already exists.Use a unique name, or delete the existing resource first.
500server_errorHyperstack-side issue.Retry with backoff. If it persists, contact [email protected].