Best-effort hook transport reachability

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

Request

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

Path parameters

namestring required

Response

OK (reachable may be null for webhook/non-unix)

detailstring nullable required

A short human note on the resolution (why false, or the resolved plugin's kind). Never a secret.

namestring required
reachableboolean nullable required

Some(true) = resolves to a loaded kind: hook plugin; Some(false) = it does not (wrong kind, or not installed/loaded), always Some, never None, as of 1.5.0's in-process plugin model.

Changes

    • info

      api operation id GetHooksNameHealth was added

    • info

      added the non-success response with the status