GET /api/fleets/{fleetId}/agents

Fleet members#

Listed permission codes are alternatives, not token scopes. The service also checks access to the requested records and rejects stale revisions or controller generations.

• Authentication, envelopes and pagination
• Language-neutral client examples

Path parameters#

object; fields below; unknown fields rejected

Validation#

check.object({ fleetId: check.identifier })

Referenced definitions:

• object
• identifier

Query parameters#

custom validation: page ; see function below

Query parameters are URL text. The validation function below specifies their format, defaults and combinations. Pagination applies only to operations that use it.

Additional checks#

The following checks apply in addition to the field limits.

Constraint on value:

export function page(input: unknown) {
    const parsed = checked(input, []);
    return parsed.ok ? pagination(parsed.value) : parsed;
}

Validation#

query.page

Referenced definitions:

• page

Request body#

empty object; unknown fields rejected

Validation#

check.empty

Referenced definitions:

• empty

Response data#

array; 0–100 entries; item: object; fields below; unknown fields rejected ( fleetAgent )

Validation#

check.list(res.fleetAgent, 100)

Referenced definitions:

• list
• fleetAgent

Response envelope#

A successful JSON response contains data and meta. Replace the data placeholder below with the response fields described above. Errors contain error instead of data.

{
  "data": "<value matching the response-data validator>",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000001",
    "page": 1,
    "pageSize": 20,
    "totalItems": 0,
    "totalPages": 1
  }
}