Air APIAPI ReferenceFleets

List visible fleets

View as Markdown
A ViewSet for Fleet instances.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idstringOptional
Filter by exact fleet id.
limitintegerOptional
Number of results to return per page.
namestringOptional
Filter by exact fleet name.
offsetintegerOptional
The initial index from which to return the results.
orderingenumOptional

Order objects by field. Prefix with - for descending order.

searchstringOptional

Search by name.

Response

countinteger
resultslist of objects
nextstring or nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error