The hook's OBSERVED state, live-queried: running settings + version (vs busbar's desired copy, with a drift verdict) and self-reported metrics. reported=null when the hook doesn't answer (fail-open)

Changed on
get/api/v1/admin/hooks/{name}/status

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-admin-token
    • HTTP bearer

Path parameters

namestring required

Response

{name, desired, reported, drift, metrics, as_of, source}

as_ofinteger required
driftboolean nullable required
drift_keysstring[] required

The DESIRED settings KEY NAMES the hook is not actually running: the actionable half of drift, carrying names this body already serves and no value from either bag. Invariantly an array (empty on the no-answer branch, where no drift is known).

namestring required
notestring nullable

A short human note present only on the fail-open (no-answer) branch.

sourcestring required

Always "live" (the read is a live transport query).

Changes

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property ///// to the response with the status

    • info

      api operation id GetHooksNameStatus was added

    • info

      added the non-success response with the status