Error object shape
All error responses include at minimum anerror field:
| Field | Type | Description |
|---|---|---|
error | string | Human-readable description of the error. |
code | string | Machine-readable error code, present on some validation and billing errors. |
upgrade | boolean | true when the error is caused by a plan limit. Prompt the user to upgrade. |
HTTP status codes
| Status | Meaning |
|---|---|
200 OK | The request succeeded. The response body contains a data field. |
201 Created | The resource was created successfully. |
401 Unauthorized | No valid API key was provided, or the key has expired. |
402 Payment Required | Your organization does not have an active subscription. |
403 Forbidden | Your API key’s role does not permit this action. |
404 Not Found | The requested resource does not exist or belongs to a different organization. |
422 Unprocessable Entity | The request body failed validation, or a plan limit has been reached. |
Common errors in detail
401 Unauthorized
Returned when theAuthorization header is missing, malformed, or contains a key that does not exist or has expired.
Authorization: Bearer ow_live_sk_... and that the key has not expired.
402 Payment Required
Returned when your organization lacks an active subscription and the endpoint requires one. This occurs onPOST /api/v1/monitors and POST /api/v1/alerts, which are write operations gated behind billing.
403 Forbidden
Returned when your API key’s role is insufficient for the requested operation. For example, aviewer key cannot create or delete resources; an admin key cannot manage API keys.
404 Not Found
Returned when the resource ID in the URL does not match any resource in your organization. Overwatch returns404 rather than exposing whether a resource exists in a different organization.
422 Unprocessable Entity
Returned for two distinct situations: Validation errors — the request body is missing required fields or contains invalid values (for example, an unsupported monitor type or alert channel type)."upgrade": true.
upgrade: true, the only way to proceed is to upgrade your plan from the Overwatch dashboard.