Vessel monitors

Pause or resume vessel monitor

Pausing stops re-screening and stops consuming quota. Resuming queues the next run immediately.

Required scope: vessel:monitor.

patch/api/v1/vessel-monitors/{id}

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/vessel-monitors/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-ArcNautical-Key

Path parameters

idstring required

Resource identifier.

Headers

Idempotency-Keystring required

Required for resource-creating POST requests. The same key and identical body replay the original response for 24 hours; a different body returns idempotency_conflict.

Request body

action'pause' | 'resume' required

Response

Successful response.

idstring uuid required
imostring required
vessel_namestring nullable
status'active' | 'paused' | 'deleted' required
customer_referencestring nullable
baseline_verdictobject nullable

The verdict changes are measured against. Null until the first run. Keys are snake_case (sanctions.coverage_complete, sanctions.coverage_gaps); the camelCase twins (coverageComplete, coverageGaps) are deprecated and will be removed after the notice on /developers/stability/.

previous_verdictobject nullable

The verdict the baseline replaced at the last confirmed change. Same keys as baseline_verdict; the vessel_risk.changed webhook carries it in this shape too.

verdict_changed_atstring date-time nullable
degradedboolean

True when the last screen came back INCOMPLETE. While degraded the baseline is deliberately NOT updated, and silence means "we could not see", not "nothing changed".

last_screening_idstring uuid nullable
last_run_atstring date-time nullable
next_run_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.