Fleet Operator

Operations of the Fleet Control API. Paths are relative to your deployment's API host.

GET /api/fleet-control-api/fleet/appliances

List appliances (optionally by client).

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
clientIdquerystringyes
StatusDescriptionBody
200application/json ApplianceDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/appliances

Register an appliance in the fleet.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json RegisterApplianceDto

StatusDescriptionBody
201application/json ApplianceDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/appliances/{id}

Get an appliance by id.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ApplianceDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/appliances/{id}/config

Get the per-appliance config overrides.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ApplianceConfigDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

PUT /api/fleet-control-api/fleet/appliances/{id}/config

Replace the per-appliance config overrides.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json SetApplianceConfigDto

StatusDescriptionBody
200application/json ApplianceConfigDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

PATCH /api/fleet-control-api/fleet/appliances/{id}/status

Update an appliance lifecycle status.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json UpdateApplianceStatusDto

StatusDescriptionBody
200application/json ApplianceDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/clients

List clients in the fleet.

Authentication: bearer token (Authorization: Bearer <token>)

StatusDescriptionBody
200application/json ClientDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/clients

Register a client in the fleet.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json CreateClientDto

StatusDescriptionBody
201application/json ClientDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/clients/{clientId}/branding

Get this customer's product-identity registration.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
clientIdpathstringyes
StatusDescriptionBody
200application/json ClientBrandingDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

PUT /api/fleet-control-api/fleet/clients/{clientId}/branding

Replace this customer's product-identity registration.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
clientIdpathstringyes

Request body: application/json SetClientBrandingDto

StatusDescriptionBody
200application/json ClientBrandingDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/fleet-control-api/fleet/clients/{clientId}/branding

Stop stating a product identity for this customer. Its appliances un-brand on their next provision.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
clientIdpathstringyes
StatusDescriptionBody
200application/json ClientBrandingDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/clients/{id}

Get a client by id.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ClientDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/customers

List customers (with counts).

Authentication: bearer token (Authorization: Bearer <token>)

StatusDescriptionBody
200application/json CustomerSummaryDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/customers

Register a customer in the fleet.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json CreateCustomerDto

StatusDescriptionBody
201application/json CustomerDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/customers/{id}

Get the full Customer aggregate (repos, distributions, entitlements, deployments, appliances).

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json CustomerDetailDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

PATCH /api/fleet-control-api/fleet/customers/{id}

Update a customer.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json UpdateCustomerDto

StatusDescriptionBody
200application/json CustomerDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/fleet-control-api/fleet/customers/{id}

Delete a customer and all its child records.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/customers/{id}/deployments

Add a deployment the customer runs.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json AddCustomerDeploymentDto

StatusDescriptionBody
201application/json CustomerDeploymentDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/fleet-control-api/fleet/customers/{id}/deployments/{deploymentId}

Remove a customer deployment.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
deploymentIdpathstringyes
idpathstringyes
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/customers/{id}/distributions

Attach a distribution the customer uses.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json AddCustomerDistributionDto

StatusDescriptionBody
201application/json CustomerDistributionDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/fleet-control-api/fleet/customers/{id}/distributions/{distributionRowId}

Remove a customer distribution.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
distributionRowIdpathstringyes
idpathstringyes
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/customers/{id}/image-entitlements

Set (upsert) a customer image-delivery entitlement.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json SetCustomerImageEntitlementDto

StatusDescriptionBody
200application/json CustomerImageEntitlementDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/fleet-control-api/fleet/customers/{id}/image-entitlements/{entitlementId}

Remove a customer image entitlement.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
entitlementIdpathstringyes
idpathstringyes
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/customers/{id}/repos

Attach a git repository the customer owns.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json AddCustomerRepoDto

StatusDescriptionBody
201application/json CustomerRepoDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/fleet-control-api/fleet/customers/{id}/repos/{repoId}

Remove a customer repo.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
repoIdpathstringyes
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/inference/gateway-descriptor

Template the llm-gateway provider descriptor from the profile active models.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
profileIdquerystringyes
StatusDescriptionBody
200application/json GatewayProviderDescriptorDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/inference/models

List declared models for a profile in the fleet.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
profileIdquerystringyes
StatusDescriptionBody
200application/json ModelConfigDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/inference/models

Declare a model available on a profile in the fleet.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json AddModelDto

StatusDescriptionBody
201application/json ModelConfigDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/inference/models/active

List ACTIVE models for a profile in the fleet.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
profileIdquerystringyes
StatusDescriptionBody
200application/json ModelConfigDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

DELETE /api/fleet-control-api/fleet/inference/models/{id}

Remove a declared model.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

PATCH /api/fleet-control-api/fleet/inference/models/{id}/activation

Activate or deactivate a declared model.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes

Request body: application/json UpdateModelActivationDto

StatusDescriptionBody
200application/json ModelConfigDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/inference/models/{id}/default

Set a model as the profile default.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ModelConfigDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/inference/render

Fetch the persisted inference render (llm-gateway provider descriptor + engine deployment values) for a profile.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
profileIdquerystringyes
StatusDescriptionBody
200application/json InferenceRenderDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/provisioning-profiles

List provisioning profiles (optionally by client).

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
clientIdquerystringyes
StatusDescriptionBody
200application/json ProvisioningProfileDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/provisioning-profiles

Create a draft provisioning profile in the fleet.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json CreateProvisioningProfileDto

StatusDescriptionBody
201application/json ProvisioningProfileDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/provisioning-profiles/{id}

Get a provisioning profile by id.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ProvisioningProfileDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/fleet-control-api/fleet/provisioning-profiles/{id}/artifact

Materialize a published profile into the deployment overlay artifact the appliance installer consumes.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ProvisioningArtifactDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/fleet-control-api/fleet/provisioning-profiles/{id}/publish

Publish (freeze) a draft profile so it can be provisioned.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json ProvisioningProfileDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto