Mirrors

Update a mirror node health state.

Update a mirror node health state.

Inputs. Path, query and header fields are listed below. The request body schema lists accepted fields and required values.

Outputs. See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.

Errors. API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.

Rate limits. Write and protocol operations can have separate route-specific limits. Read Retry-After and retry_after_s when present; do not infer a write allowance from the public read budget.

Example setup. Use an identifier returned by the matching list, search or create operation. Sample identifiers are not a promise that a record exists. Set HUGGING_BAY_TOKEN to a credential with the role or scope stated by this operation. Reader tokens do not grant publisher or operator rights. This example is not executed by documentation checks. Review the operation and obtain any required user consent before sending it.

patch/api/mirrors/{id}

Request

  • Base URL: https://huggingbay.xyz
  • URL: https://huggingbay.xyz/api/mirrors/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

health'healthy' | 'stale' | 'degraded' | 'quarantined'

Response

Mirror updated

idstring required
namestring required
regionstring required
endpointstring uri required
health'healthy' | 'stale' | 'degraded' | 'quarantined' required
publicOnlyboolean required
freshnessMinutesnumber required
artifactCountnumber required
bandwidthTbnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.