...
post /v3/fleets/{fleetId}/vessels
(addVessel)
Adds new vessel to a Fleet. A maximum of 1000 vessels can be added to a fleet.
...
application/json
Request body
body Request object for adding a Vessel to a Fleet (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Vessel1
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
post /v3/fleets/{fleetId}/batch-add-vessels
...
application/json
Request body
body Request object for batch adding Vessels to a Fleet (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3EmptyResponse
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
post /v3/fleets
(createFleet)
...
application/json
Request body
body v3CreateFleetRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Fleet
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
delete /v3/fleets/{fleetId}
...
Path Parameter — Identifier of the Fleet resource to be deleted.
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3EmptyResponse
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
delete /v3/fleets/{fleetId}/vessels/{imo}
...
Path Parameter — IMO number of the Vessel to be deleted. format: int32
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3EmptyResponse
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
get /v3/fleets/{fleetId}
(describeFleet)
...
Path Parameter — Identifier of the Fleet resource to be retrieved.
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Fleet
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
delete /v3/fleets/{fleetId}/drop-vessels
...
Path Parameter — Identifier of the Fleet resource where vessels should be dropped.
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3EmptyResponse
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
get /v3/fleets/livemap
(getFleetLiveMap)
...
Query Parameter — Specifies the map theme. Allowed values are: [light-v10, dark-v10, navigation-night-v1, navigation-day-v1, outdoors-v11, satellite-v9].
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3GetFleetLiveMapResponse
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
get /v3/fleets
(listFleets)
Lists Fleets for the current user (or fleets that are shared with the current user)
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Fleets
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
get /v3/fleets/{fleetId}/vessels
...
Path Parameter — Identifier of the Fleet resource which vessels to be retrieved.
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Vessels
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
get /v3/fleets/{fleetId}/vessels-with-status
...
Query Parameter — The UTC end date of the date filter for related events (StoppageEvents etc.).
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Vessels
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
put /v3/fleets/{fleetId}/rename-fleet
...
application/json
Request body
body Request object for renaming a Fleet (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Fleet
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
post /v3/fleets/{fleetId}/replace-vessels
...
application/json
Request body
body Request object for batch adding Vessels to a Fleet_1 (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3EmptyResponse
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
put /v3/fleets/{fleetId}/share-fleet
...
Path Parameter — Identifier of the Fleet resource to be shared.
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Fleet
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
put /v3/fleets/{fleetId}/unshare-fleet
...
Path Parameter — Identifier of the Fleet resource to be shared.
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Fleet
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
put /v3/fleets/{fleetId}/vessels/{imo}
...
application/json
Request body
body Request object for updating a vessel (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3Vessel1
default
An unexpected error response. rpcStatus
| Anchor | ||||
|---|---|---|---|---|
|
post /v3/fleets/upload-fleet-list
...
application/json
Request body
body v3GetFleetListRequest (required)
Body Parameter —
Return type
Example data
Content-Type: application/json
...
200
A successful response. v3EmptyResponse
default
An unexpected error response. rpcStatus