Fleets

Screen every hull in the fleet

Queues a screening for every member, chunked into the same batch machinery as POST /api/v1/screening-batches and processed by the same worker. Reserves one screening unit per hull up front. Returns the batch ids so you can poll GET /api/v1/screening-batches/{id}, then read the result through the fleet exposure and changes endpoints.

Required scope: vessel:screen.

post/api/v1/fleets/{id}/refresh

Request

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

Path parameters

idstring uuid required

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.

Response

Screening queued.

fleet_idstring uuid required
queued_vesselsinteger required
batch_idsstring[] required

Poll each at GET /api/v1/screening-batches/{id}.

statusstring

Changes

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