Fleet
Fleet Object
| Field | Type | Description |
|---|---|---|
| id | snowflake | the fleet's id |
| organisation | organisation object | the organisation the fleet belongs to |
| code | string | a short code for the fleet (2-6 characters) |
| name | string | a name for the fleet (up to 2-50 characters) |
| description | string | a description for the fleet |
List Fleets
GET /organisations/{organisation.id}/fleets
Returns an array of fleet objects for the organisation.
Create Fleet
POST /organisations/{organisation.id}/fleets
Get Fleet
GET /fleets/{fleet.id}
Modify Fleet
PATCH /fleets/{fleet.id}
List Fleet Assets
GET /fleets/{fleet.id}/assets
Parameters
| Field | Type | Description |
|---|---|---|
| type | ?snowflake | the type of asset to return |
| root | ?boolean | when set to true, only the root assets will be returned |
| active | ?boolean | when set to true, only active assets will be returned |