Update VirtualModel

View as Markdown
Partially update a VirtualModel. Only fields present in the request body are modified. Fields absent from the request body retain their current values.

Path parameters

workspacestringRequired
namestringRequired

Request

This endpoint expects an object.
default_model_entitystringOptional

Model entity to route to, in “workspace/name” format. Written into request[“model”] before the request middleware pipeline runs. If omitted, a request middleware plugin must handle backend routing itself. Set to null to clear an existing value.

autoprovisionedbooleanOptionalDefaults to false

Marks this VirtualModel as controller-managed. The Models controller will delete it once no ModelProvider serves the matching entity. Setting this manually opts the VirtualModel into that cleanup behavior.

modelslist of objectsOptional

Model entity references used by this VirtualModel. A per-entry backend_format overrides the referenced ModelEntity backend_format when IGW resolves the backend format for a request.

request_middlewarelist of objectsOptional

Ordered list of middleware plugins applied before proxying to the backend. Each entry is a MiddlewareCall with a “name” (plugin identifier) and optional “config_type” and “config_id” fields that reference a stored plugin configuration.

response_middlewarelist of objectsOptional
Ordered list of middleware plugins applied after the backend response is received, before returning it to the caller.
post_response_middlewarelist of objectsOptional

Ordered list of middleware plugins invoked after the response has been returned to the caller. Intended for fire-and-forget work (logging, analytics) that must not block or modify the response.

override_proxystringOptional

Plugin-provided proxy implementation for IGW to use instead of its default aiohttp proxy. Format: “plugin-name.proxy-name”. Leave unset to use the default IGW proxy. Set to null to clear an existing value.

Response

Updated virtual model
workspacestringformat: "^[\w\-\+.@:]+$"
Workspace identifier
idstringRead-only
created_atdatetimeRead-only
created_bystring or nullRead-only
updated_atdatetimeRead-only
updated_bystring or nullRead-only
entity_idstringRead-only
Alias for id for backwards compatibility.
parentstringRead-only
Parent entity ID for nested entities.
namestringDefaults to
Entity name within the workspace
projectstring
The name of the project associated with this entity.
default_model_entitystring
autoprovisionedbooleanDefaults to false

Marks this VirtualModel as controller-managed. The Models controller will delete it once no ModelProvider serves the matching entity. Setting this manually opts the VirtualModel into that cleanup behavior.

modelslist of objects
request_middlewarelist of objectsDefaults to []
response_middlewarelist of objectsDefaults to []
post_response_middlewarelist of objectsDefaults to []
override_proxystring

Errors

404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error