Skip to main content
POST
Stop a deployment and tear down the live resource

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

model
string
required
name
string
required

Response

Successful Response

deployment_id
string<uuid>
required
name
string
required
type
enum<string>
required
Available options:
batch,
online
status
enum<string>
required
Available options:
pending,
deploying,
active,
failed,
stopped,
archived
domain
string
required
owner
string
required
model
ModelReference · object
required

A registered MLflow model with either a version number or an alias.

Provide exactly one of model_version or model_alias. A version number deploys a specific model release. An alias resolves to a concrete version at deployment creation time.

created_at
string<date-time>
required
updated_at
string<date-time>
required
resolved_model_version
string | null

The model version this deployment currently uses. When the deployment references an alias, this shows the resolved version number.

dag_id
string | null
dag_s3_uri
string | null
schedule
string | null
last_run
DeploymentRunSummary · object | null
service_url
string | null
replica_count
integer | null
ready_replicas
integer | null
allowed_roles
string[] | null
error_message
string | null
stopped_at
string<date-time> | null