API REFERENCE · SCHEMA

MonitorControl schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas

Revision-guarded controls. In addition to expectedRevision, supply at least one of status, intervalHours or runNow.

expectedRevisionRequired
integer

Current revision from GET /monitoring. A stale value returns stale_revision; reload before applying your change.

Minimum: 1. Maximum: 9007199254740991.

statusConditional
string

Set paused to stop scheduled work or active to resume. Resume revalidates policy, coverage, counterparty and monitor allowance.

Values: "active", "paused".

intervalHoursConditional
6 or 24 or 168

Supported schedule interval in hours: 6, 24 or 168. Policy-backed monitors must keep their approved policy cadence.

intervalHours fields and rules

Allowed alternatives

  • 6

    Must equal 6.

  • 24

    Must equal 24.

  • 168

    Must equal 168.

runNowConditional
true

When true, queue a fresh check for an active monitor. Omit if not requested; false is not accepted. The response confirms queued control work, not a completed screening.

Must equal true.

Allowed alternatives

  • Provide status.
  • Provide intervalHours.
  • Provide runNow.

Additional fields are not accepted.