Update ModelDeployment Status

POST

https://host.com/apis/models/v2/workspaces/:workspace/deployments/:name/status

POST

/apis/models/v2/workspaces/:workspace/deployments/:name/status

$ curl -X POST https://host.com/apis/models/v2/workspaces/workspace/deployments/name/status \
>      -H "Content-Type: application/json" \
>      -d '{
>   "status": "READY"
> }'

1 {
2   "name": "llama-3.1-8b",
3   "workspace": "research-team",
4   "created_at": "2024-01-15T09:30:00Z",
5   "updated_at": "2024-04-20T14:45:00Z",
6   "entity_version": 3,
7   "config": "llama-config-v3",
8   "config_version": 3,
9   "id": "deployment-12345",
10   "project": "nlp-models",
11   "status": "READY",
12   "status_message": "Deployment is active and ready to serve requests.",
13   "status_history": [
14     {
15       "timestamp": "2024-01-15T09:30:00Z",
16       "status": "CREATED",
17       "status_message": "Deployment created."
18     },
19     {
20       "timestamp": "2024-02-10T11:00:00Z",
21       "status": "PENDING",
22       "status_message": "Deployment is pending resource allocation."
23     },
24     {
25       "timestamp": "2024-04-20T14:45:00Z",
26       "status": "READY",
27       "status_message": "Deployment is active and ready to serve requests."
28     }
29   ],
30   "model_provider_id": "provider-workspace/llama-models",
31   "auth_context": {
32     "principal_id": "user-7890",
33     "principal_email": "alice@example.com",
34     "principal_groups": [
35       "ml-engineers",
36       "research-team"
37     ],
38     "principal_on_behalf_of": "user-1234",
39     "principal_on_behalf_of_groups": [
40       "admin-group"
41     ],
42     "principal_on_behalf_of_email": "admin@example.com"
43   }
44 }

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: "^[\w\-.]+$"<=255 characters

Name of the entity. Name/workspace combo must be unique across all entities. Allowed characters: letters (a-z, A-Z), digits (0-9), underscores, hyphens, and dots.

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

idstring

Unique identifier for the deployment

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

The URN of the project associated with this entity.

statusenumDefaults to UNKNOWN

Current status of the deployment, populated by models controller

status_messagestring<=1000 charactersDefaults to

Detailed status message, populated by models controller

status_historylist of objects

History of status changes, ordered chronologically (oldest first)

model_provider_idstring<=255 characters

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

auth_contextobject

Auth context captured at deployment creation.

Errors

422

Unprocessable Entity Error