daemon

Prepare a leased update drain

Changed on
post/api/update/prepare

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

$schemastring uri

A URL to the JSON Schema for this object.

owner_idstring required
policy'wait' | 'interrupt' | 'abort' required

Example request

{
  "$schema": "https://example.com/UpdateDrainRequestBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

active_workersinteger required
expires_atstring date-time required
lease_tokenstring
policystring required
recoveringboolean required
running_jobsinteger required
targeted_running_jobsinteger required

Example response

{
  "$schema": "https://example.com/UpdateDrainStatus.json"
}

Changes