52bf0279Record actual native close on the current controller generation after all receipts settle#
| Property | Value |
|---|---|
| Service | crossfire |
| Operation | recordFleetNativeStop |
| Method | PUT |
| Path | /api/fleets/{fleetId}/agents/{agentId}/native-stop |
| Authentication | fleet |
| Success status | 200 |
| Response data | Unpaginated value |
| Request format | json |
| Maximum request body | 2097152 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
| Field path | Representation and constraints |
|---|---|
fleetId | lowercase opaque UUID |
agentId | lowercase opaque UUID |
Validation#
check.object({ fleetId: check.identifier, agentId: check.identifier })Referenced 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#
query.noneReferenced definitions:
Request body#
object; fields below; unknown fields rejected
| Field path | Representation and constraints |
|---|---|
connectionId | lowercase opaque UUID |
runId | lowercase opaque UUID |
receiptId | lowercase opaque UUID |
Validation#
check.object({ connectionId: check.identifier, runId: check.identifier, receiptId: check.identifier })Referenced definitions:
Response data#
object; fields below; unknown fields rejected (
recorded
)
| Field path | Representation and constraints |
|---|---|
recorded | boolean |
Validation#
res.recordedReferenced 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"
}
}