Skip to content
Avaloi

API errors

Read RFC 9457 Problem Details, the errors array for field issues, and the request_id to quote to support.

Errors use RFC 9457 Problem Details. Field validation adds an errors array. Every error carries a request_id.

{
  "type": "https://api.avaloi.com/problems/403",
  "title": "Forbidden",
  "status": 403,
  "detail": "This key lacks users:write.",
  "request_id": "01J9K2Q7M4Z8X0T6Y3B5N1C2D4",
  "errors": [
    { "field": "scopes", "message": "users:write is required.", "code": "missing_scope" }
  ]
}

Status codes

Status When
400 Bad request body.
401 Missing or revoked key.
402 The company has no plan and the request creates a real site. The problem type is payment-required. Set test to true for a free test site.
403 Authenticated, but the key or role cannot do this.
404 Unknown path or resource.
409 Conflict, for example a duplicate slug or a merge with conflicting files.
422 Validation failed, an Idempotency-Key was reused with a different body, or a WP-CLI command is not on the allowlist.
429 Rate limited. Read Retry-After.
5xx Our fault. Retry with the same Idempotency-Key on POST.

Quick answers

Which field is wrong? Read the errors array. Each entry names the field, a message, and a code.

A POST failed with a 5xx. Can I retry? Yes. Send the same Idempotency-Key and body. Avaloi replays the first result if the call went through. See API idempotency.

What do I send to support? The request_id, the status, and the detail. Never send the key.

Still stuck?

Email [email protected] with your site name and what you tried, or send us a message.