POST /api/fleets/{fleetId}/session-operations

Request stop, resume or confirmed fresh history through the controller#

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

HTTP 202 means the request was accepted for processing. Check the operation’s status to find out whether it completed.

• Authentication, envelopes and pagination
• Language-neutral client examples

Path parameters#

object; fields below; unknown fields rejected

Validation#

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

Referenced definitions:

• object
• identifier

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.none

Referenced definitions:

• none

Request body#

object; fields below; unknown fields rejected; constraint: Fresh history requires explicit confirmation ( runtimeRequest )

Additional checks#

The following checks apply in addition to the field limits.

Constraint on object:

value => value.confirmFreshHistory === (value.action === 'reset')

Validation#

fleetRuntime.runtimeRequest

Referenced definitions:

• runtimeRequest

Response data#

object; fields below; unknown fields rejected; constraint: Invalid session operation outcome ( runtimeOperation )

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.runtimeOperation

Referenced definitions:

• runtimeOperation

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