52bf0279Change Crossfire delivery intent#
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 | changeFleetDelivery |
| Method | PUT |
| Path | /api/fleets/{fleetId}/delivery |
| 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 (
params
)
| Field path | Representation and constraints |
|---|---|
fleetId | lowercase opaque UUID |
Validation#
paramsReferenced 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#
object; fields below; unknown fields rejected (
deliveryChange
)
| Field path | Representation and constraints |
|---|---|
expectedRevision | exact JSON integer; 0…9007199254740991 |
enabled | boolean |
Validation#
deliveryChangeReferenced definitions:
Response data#
object; fields below; unknown fields rejected (
fleetControl
)
| Field path | Representation and constraints |
|---|---|
fleetId | lowercase opaque UUID |
revision | exact JSON integer; 0…9007199254740991 |
deliveryEnabled | boolean |
connection | object; fields below; unknown fields rejected |
connection.status | online or offline |
connection.lastSeenAt | exact JSON integer; 0…9007199254740991; JSON null permitted |
Validation#
fleetControlReferenced 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"
}
}