Vessel monitors

Monitor many hulls at once

Enrols up to 500 hulls in one request, and is SAFE TO RE-RUN: a hull already monitored comes back as already_monitored with its existing id rather than an error, so a nightly "sync my fleet list" job needs no local mirror of what we already hold.

Answers 200 with a per-item outcome rather than failing the whole request on one bad hull — a sync of 400 hulls containing three malformed IMOs enrols 397 and names the three. Each results[] entry carries status: created, already_monitored, invalid (with message), or limit_exceeded.

The account monitor cap still applies and is consumed in list order. It is not arbitrary: each monitor run spends one screening unit (two on a change), so a filled cap at the 24h cadence costs about 1,500 units a month. Read monitor_limit and monitors_used on the response to see where you stand.

With a TEST key the whole book is created but never scheduled and never metered, so you can rehearse a fleet sync at full size for nothing. Fire events with POST /api/v1/vessel-monitors/{id}/simulate.

Required scope: vessel:monitor.

post/api/v1/vessel-monitors/batch

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/vessel-monitors/batch
  • 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

Response

Per-hull outcomes. Check each result rather than only the HTTP status.

createdinteger required
already_monitoredinteger required

Hulls already watched. A SUCCESS — this is what makes a re-run a no-op.

invalidinteger required
limit_exceededinteger required

Hulls refused because the account monitor cap was reached.

monitor_limitinteger
monitors_usedinteger

Changes

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