Vessel monitors

List vessel monitors

Vessel monitors for the authenticated customer and environment, newest first. Paginated: pass the next_cursor from the previous page and stop when has_more is false. changed_since is the cheap way to ask the only question that matters daily — which hulls in my book moved — without walking the whole collection.

Required scope: vessel:monitor.

get/api/v1/vessel-monitors

Request

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

Query parameters

cursorstring

Opaque cursor returned by the previous page.

limitinteger

Maximum items to return. A value above the maximum is refused with 422, not clamped.

imostring

Only the monitor watching this hull.

customer_referencestring

Only monitors carrying this reference.

status'active' | 'paused'

Filter by monitor state.

degradedboolean

Only monitors whose last run could not read the lists (true), or only healthy ones (false).

changed_sincestring date-time

Only monitors whose verdict changed at or after this time.

Response

Successful response.

next_cursorstring nullable

Pass as cursor for the next page. Null on the last page.

has_moreboolean

Changes

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