52bf0279Read retained native history identities without starting a session#
Private controller API. Call this route through the user’s Unix socket, locally or over SSH. It is not exposed on the server’s public origin.
| Property | Value |
|---|---|
| Service | fleetd |
| Operation | contexts |
| Method | GET |
| Path | /api/fleets/{fleetId}/agents/{instanceKey}/contexts |
| Authentication | public |
| Success status | 200 |
| Response data | Unpaginated value |
| Request format | json |
| Maximum request body | 1048576 bytes (service default) |
| Permission codes | None declared |
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 (
agentParams
)
| Field path | Representation and constraints |
|---|---|
fleetId | lowercase opaque UUID |
instanceKey | lowercase name; pattern [a-z][a-z0-9-]{0,39} |
Validation#
agentParamsReferenced definitions:
Query parameters#
custom validation:
none
; 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 none(input: unknown) {
const parsed = listQuery([])(input);
return parsed.ok ? success({}) : parsed;
}Validation#
noneReferenced definitions:
Request body#
empty object; unknown fields rejected
Validation#
check.emptyReferenced definitions:
Response data#
array; 0–2002 entries; item: object; fields below; unknown fields rejected
| Field path | Representation and constraints |
|---|---|
[].context | string; 1–255 UTF-16 units; well-formed Unicode; no C0/DEL controls |
[].runtime | lowercase name; pattern [a-z][a-z0-9-]{0,39} |
[].sessionId | string; 1–200 UTF-16 units; well-formed Unicode; no C0/DEL controls |
Validation#
check.list(check.object({ context: check.text(255), runtime: check.name, sessionId: check.text(200) }), 2002)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"
}
}