This API allows you to remove a registered vessel from a specific category (categoryId).
If categoryId is not provided in the request, the vessel will be removed from all categories it currently belongs to. Please note that immediate deletion is not allowed — by default, a vessel can only be removed 7 days after registration.
Authentication
The Fleet API uses Basic Authorization on Swagger UI.
Authentication Steps
1.
Click the [Authorize] button in the top right corner.
2.
Enter the provided username and password in the pop-up window.
3.
Click [Authorize] again to proceed with authentication.
4.
After successful login, click [Close] to close the window.
All API requests from Swagger UI will automatically include the authorization token.
Request Information
Request URL
Request URL : [DELETE] https://insight.seavantage.com/api/fleet
Execution Steps
1.
2.
Navigate to the /fleet endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the request parameters below:
•
categoryId + shipId: Deletes the specified vessel from the specified category.
◦
categoryId is a UUID value that can be retrieved via the [GET] /fleet or [GET] /fleet/snapshot APIs.
•
shipId only: Deletes the vessel from all categories it currently belongs to.
◦
5.
Click [Execute].
6.
View results in the response section.
Use this API to remove a vessel from a defined category, as part of managing vessels by category.
Response Information
The response is returned in the following format, regardless of whether the request is successful or failed.
Sample Response Format
•
If successful:
◦
HTTP Status: 204 No Content
◦
Response Body: None
•
If fail:
{
"code": 400,
"message": "Invalid request body. Trace id : 5d4c6d66874f3faeeb186d5137bc799f",
"error": true,
"timestamp": "2024-12-01T12:00:00",
"response": null
}
JavaScript
복사
Response Field Descriptions
Top-Level Response Fields
Field | Example Value | Description |
code | 400 | Response status code (used in the same way as standard HTTP status codes).
See the list of codes below for reference. |
message | Invalid request body. | Response message (description based on status) |
error | true | Error flag
true: error occurred
false: successful processing |
timestamp | 2024-12-01T12:00:00 | Time of response creation (UTC) |
Response Codes
Code | Description |
204 | Deleted |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |