Sign in
hydra

Update a Hydra Host. (admin access required)

Changed on

Updates a Host label, status or tokens. Setting status to Draining keeps existing heads served while accepting no new placements, which matters because a head cannot be moved to another Host.

patch/hydra/host

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/hydra/host
  • Auth: API key in header token

Request body

idstring required
namestring
status'Active' | 'Draining' | 'Unreachable' | 'Disabled'

Draining keeps serving existing heads (they cannot be moved) but takes no new placements

userTokenstring

Opaque bearer token issued by the Hydra Host. Stored encrypted and never returned.

adminTokenstring nullable

Null clears the admin token, disabling provisioning

allowInsecureHttpboolean

Explicitly allow bearer tokens over this Host HTTP connection

Response

Updated host

status'success' required

Example response

{
  "status": "success"
}

Changes