Corridor monitors

Pause or resume corridor monitor

Updates one monitor status to active or paused.

Required scope: voyage:monitor.

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

Request

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

Path parameters

idstring required

Resource identifier.

Request body

action'pause' | 'resume' required

Response

Successful response.

idstring required
customer_referencestring
status'active' | 'paused' | 'deleted' required
baseline_scorenumber nullable
baseline_levelstring nullable
confidencenumber nullable
last_run_atstring date-time nullable
next_run_atstring date-time required
created_atstring date-time required
updated_atstring date-time required

Changes

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