Corridor monitors

Create corridor monitor

Creates a live six-hour corridor monitor and queues the first baseline immediately. Test keys cannot create corridor monitors. The sandbox currently covers VESSEL monitors only — see POST /api/v1/vessel-monitors/{id}/simulate — so a webhook handler is best rehearsed there.

Required scope: voyage:monitor.

post/api/v1/corridor-monitors

Request

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

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

customer_referencestring

Response

Monitor created and baseline queued.

idstring required
status'active' required
next_run_atstring date-time required

Changes

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