DocumentationReferenceAPI ReferenceModel Deployments

Update ModelDeployment Status

View as Markdown

Update the status of a ModelDeployment (mutable operation). If version is not specified, updates the latest version.

Path parameters

workspacestringRequired
namestringRequired

Query parameters

versionstringOptional

Request

This endpoint expects an object.
statusenumRequired
New status for the deployment
status_messagestringOptional<=1000 charactersDefaults to
Detailed status message
model_provider_idstringOptional<=255 characters

Optional reference to the auto-created ModelProvider workspace/name (format: workspace/name)

Response

Update ModelDeployment status and status_message

namestringformat: "^[a-z](?!.*--)[a-z0-9\-@.+_]{1,62}(?<!-)$"<=63 characters

Name of the entity. Name/workspace combo must be unique across all entities. Name must start with a lowercase letter, be 2-63 characters, and use lowercase letters, digits, hyphens, and dots (no consecutive hyphens, cannot end with a hyphen).

workspacestringformat: "^[\w\-.]+$"<=255 characters

The workspace of the entity. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.

created_atdatetime
The timestamp of model entity creation
updated_atdatetime
The timestamp of the last model entity update
entity_versioninteger
Version of this deployment. Automatically managed.
configstring<=255 characters
Reference to the ModelDeploymentConfig name
config_versioninteger
Reference to the specific ModelDeploymentConfig version
idstringOptional
Unique identifier for the deployment
projectstringOptionalformat: "^[\w\-./]+$"<=255 characters
The URN of the project associated with this entity.
statusenumOptionalDefaults to UNKNOWN
Current status of the deployment, populated by models controller
status_messagestringOptional<=1000 charactersDefaults to
Detailed status message, populated by models controller
status_historylist of objectsOptional

History of status changes, ordered chronologically (oldest first)

model_provider_idstringOptional<=255 characters

Optional reference to the auto-created ModelProvider workspace/name (format: workspace/name)

auth_contextobjectOptional
Auth context captured at deployment creation.

Errors

422
Unprocessable Entity Error