52bf0279Claim an authorized session operation on the live controller generation#
| Property | Value |
|---|---|
| Service | crossfire |
| Operation | claimFleetRuntime |
| Method | PUT |
| Path | /api/fleets/{fleetId}/session-operations/{operationId}/claim |
| 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 |
operationId | lowercase opaque UUID |
Validation#
check.object({ fleetId: check.identifier, operationId: 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 (
runtimeClaim
)
| Field path | Representation and constraints |
|---|---|
connectionId | lowercase opaque UUID |
Validation#
fleetRuntime.runtimeClaimReferenced definitions:
Response data#
object; fields below; unknown fields rejected; constraint: Invalid session operation outcome (
runtimeOperation
)
| Field path | Representation and constraints |
|---|---|
operationId | lowercase opaque UUID |
fleetId | lowercase opaque UUID |
agentId | lowercase opaque UUID; JSON null permitted |
action | start or stop or reset (
runtimeAction
) |
expectedRevision | exact JSON integer; 0…9007199254740991 |
status | pending or running or succeeded or failed |
createdAt | exact JSON integer; 0…9007199254740991 |
completedAt | exact JSON integer; 0…9007199254740991; JSON null permitted |
errorMessage | string; 1–4096 UTF-16 units; well-formed Unicode; no C0/DEL controls; JSON null permitted |
Additional checks#
The following checks apply in addition to the field limits.
Constraint on object:
value => (value.status === 'succeeded' || value.status === 'failed') === (value.completedAt !== null)
&& (value.status === 'failed') === (value.errorMessage !== null)Validation#
fleetRuntime.runtimeOperationReferenced 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"
}
}