Hole Monitor

Errors

Errors are RFC 9457 problem documents, sent with content-type: application/problem+json:

{ "type": "https://holemonitor.live/docs/errors#validation", "title": "Validation failed", "status": 422,
  "detail": "url: must use https", "errors": [{ "field": "url", "message": "must use https" }] }

bad-request

  1. The body is not valid JSON, or a header is malformed.

unauthorized

  1. No credentials, or the API key is invalid or revoked.

forbidden

  1. The key lacks write scope, the route needs a dashboard session, the account is suspended, or a plan limit was reached. A plan-limit problem has title "Plan limit reached" and a limit field naming the limit: terms, endpoints, broad_filters, api_keys.

not-found

  1. The object does not exist or belongs to another account.

conflict

  1. An Idempotency-Key was reused for a different request, or the object's state does not allow the change.

gone

  1. The object existed and was removed.

too-large

  1. The request body is too large.

validation

  1. The body failed validation. errors lists each field and message.

rate-limited

  1. Too many requests. Wait for retry-after seconds.

internal

  1. An unexpected error. Retrying with the same Idempotency-Key is safe.

unavailable

  1. A dependency is unavailable. Retry later.