Fleets

Register a fleet

Registers a named list of hulls you care about, so you do not have to manage a subscription per vessel. A fleet holds MEMBERSHIP only and stores no verdict of its own: exposure and changes are read live from your screenings, so a fleet summary can never drift from the screening records behind it. Duplicate IMOs in the list are de-duplicated. Registering a fleet does NOT screen it and reserves no quota — call POST /api/v1/fleets/{id}/refresh when you want the hulls screened, so a bill is never started by an upload you were only staging.

Required scope: vessel:screen.

post/api/v1/fleets

Request

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

namestring required

Response

Fleet registered. Not yet screened.

idstring uuid required
namestring required
vessel_countinteger required
created_atstring date-time
screenedboolean

Always false on create — registering a fleet does not screen it.

next_stepstring

Changes

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