Errors and retries
Check both the HTTP status and the JSON body when a request fails. Authentication and permission failures return 401.
Note: Balancer is in beta. Endpoints, fields and behavior may change before general availability, and the feature must be enabled on your account before use. Contact your NetActuate account manager to request access.
Response body
{
"code": 400,
"message": "Your request is not valid.",
"result": "error"
}
| Field | Meaning |
|---|---|
code | Numeric response status. |
message | Description of the failure. |
result | Some response paths include error; do not require this field on every error. |
errors | Validation-dependent details, sometimes an array. |
error_details | Validation-dependent details, including bad_values on some paths. |
bad_fields | Present on some authorization or resource validation paths. |
Do not depend on every optional field being present.
Status codes
These are the status codes recorded for the API operations. An endpoint returns only the codes applicable to its behavior.
| HTTP status | When it happens | What to do |
|---|---|---|
| 200 | Successful read, write acknowledgement or sign-in challenge. | Inspect the data. For writes, read back configuration and check activation separately. |
| 400 | Missing or invalid arguments, unsupported values or rejected configuration. | Correct the fields or configuration before retrying. |
| 401 | Missing, invalid, expired or revoked credentials; wrong credential context; insufficient access; inactive membership or blocked account. | Correct credentials, context or permissions. Repeating the same request does not resolve the cause. |
| 404 | The resource is missing, deleted, outside your account or outside the authorized parent. | Check identifiers, ownership and parent selection. |
| 409 | A duplicate name, priority or assignment; conflicting DNS records; an in-use resource; an enforced count or configuration budget; an unavailable feature. | Resolve the conflict, remove references or reduce the configuration as directed by the message. |
| 412 | A supplied resource version does not match the locked version, or the checked resource disappeared. | Read the resource again and reconcile your change before resubmitting. |
| 500 | An unhandled server failure. | Check whether a write took effect before retrying. |
| 503 | A validation dependency is unavailable, fails or returns an unsupported response. | Retry later after checking saved state. |
Retry safely
For 500, 503 or a lost response, read back the affected resource before resending a write. A failure to receive success does not establish that nothing changed. Do not automatically repeat a creation request: it can create another object. For 412, follow version conflict handling.
TODO(verify): Confirm any supported retry delay, retry headers, request deduplication mechanism and API request-rate limit. No numeric retry schedule is established by the available facts.