Errors

A failed request returns a non-2xx status and a JSON body:

{
  "code": "invalid_state",
  "message": "resource state conflicts with the operation",
  "retryable": false
}

Field	Type	Meaning
`code`	string	Stable, machine-readable reason. Branch on this and the HTTP status.
`message`	string	Human-readable description. Its wording can change; do not parse it.
`retryable`	boolean	`true` when sending the same request again later may succeed.

If retryable is false, change something before sending the request again: the request, your permissions, or the state of the resource. If it is true, retry with exponential backoff and a deadline. For a write, keep the same Idempotency-Key and body when you retry (see Retrying writes). One endpoint differs. POST /organizations/{orgID}/ssh-keys reports its own errors with error in place of message, for example {"error": "conflict", "code": "invalid_state", "retryable": false}. code and retryable mean the same thing. Its authentication and schema errors use the standard body.

Validation errors

When a parameter fails the request schema before the endpoint runs, both APIs return 422 with code invalid_request. An example is a limit above 200.

Codes

These are the codes the endpoints in this reference return. The OpenAPI documents list more, for endpoints not covered here.

Status	Code	API	Meaning	What to do
400	`invalid_request`	both	The body or a header is malformed or missing.	Fix the request.
400	`invalid_organization`	Platform	The organization query parameter is missing.	Add `businessOrgId` or `organizationId`; see Organization in the request.
400	`invalid_cluster`	Platform	The cluster ID is not a UUID.	Use the `id` from a cluster list.
400	`invalid_pagination`	Platform	`after` is not a valid ID.	Pass the token from the previous page unchanged.
400	`invalid_scheduler_config`	Platform	A Slurm setting failed validation.	See Slurm configuration.
401	`unauthorized`	both	No token or an expired token. Business also returns this for a service-account token.	Run `andromeda auth login`. See Authentication.
403	`forbidden`	both	You lack the permission the endpoint needs. Platform also returns this for a service-account token.	Ask an organization owner or admin; see Permissions.
404	`not_found`	both	The resource does not exist, or it is not in the organization you named.	Check the ID and organization.
409	`invalid_state`	both	The resource is not in a state that allows the request.	Read the resource. Each endpoint page says what causes this.
409	`idempotency_mismatch`	Business	The `Idempotency-Key` was already used with a different body.	Use a new key for a new operation.
422	`invalid_request`	both	A parameter failed schema validation.	Fix the parameter named in `message`.
503	`service_unavailable`, `integration_unavailable`	both	A dependency is temporarily unavailable. `retryable` is `true`.	Retry with backoff.
503	`customer_kubernetes_login_not_configured`	Platform	This environment does not offer Kubernetes sign-in.	Contact Andromeda Support.

Overview

Business API

Platform API

Validation errors

Codes

​Validation errors

​Codes

Validation errors

Codes