Listener history#

PropertyValue
Servicecrossfire
OperationlistenerRuns
MethodGET
Path/api/agents/{agentId}/listener-runs
Authenticationeither
Success status200
Response dataPaginated collection
Request formatjson
Maximum request body2097152 bytes (service default)
Permission codesagent.read.self, agent.read.owned, agent.read.any

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

Path parameters#

object; fields below; unknown fields rejected

Field pathRepresentation and constraints
agentIdlowercase opaque UUID

Validation#

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

Referenced definitions:

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:

Request body#

empty object; unknown fields rejected

Validation#

check.empty

Referenced definitions:

Response data#

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

Field pathRepresentation and constraints
[].runIdlowercase opaque UUID
[].agentIdlowercase opaque UUID
[].releasestring; 1–200 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted
[].controllerobject; fields below; unknown fields rejected; JSON null permitted
[].controller.fleetIdlowercase opaque UUID
[].controller.connectionIdlowercase opaque UUID
[].controller.credentialIdlowercase opaque UUID
[].startedAtexact JSON integer; 0…9007199254740991
[].lastSeenAtexact JSON integer; 0…9007199254740991
[].activeMsexact JSON integer; 0…9007199254740991
[].messagesDeliveredexact JSON integer; 0…9007199254740991
[].stoppedAtexact JSON integer; 0…9007199254740991; JSON null permitted
[].disconnectRequestedAtexact JSON integer; 0…9007199254740991; JSON null permitted

Validation#

check.list(res.listenerRun, 100)

Referenced definitions:

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
  }
}