Authorizations

Authorization
string
headerrequired

You must specify the scheme 'Api-Key' in the Authorization header. For example, Authorization: Api-Key <Your_Api_Key>

Path Parameters

model_id
string
required
env_name
string
required

Body

application/json

A request to promote a deployment to a environment.

deployment_id
string
required

The id of the deployment to promote

scale_down_previous_deployment
boolean
default: true

Whether to scale down the previous deployment after promoting

Response

200 - application/json

A deployment of a model.

id
string
required

Unique identifier of the deployment

created_at
string
required

Time the deployment was created in ISO 8601 format

name
string
required

Name of the deployment

model_id
string
required

Unique identifier of the model

is_production
boolean
required

Whether the deployment is the production deployment of the model

is_development
boolean
required

Whether the deployment is the development deployment of the model

status
enum<string>
required

Status of the deployment

Available options:
BUILDING,
DEPLOYING,
DEPLOY_FAILED,
LOADING_MODEL,
ACTIVE,
UNHEALTHY,
BUILD_FAILED,
BUILD_STOPPED,
DEACTIVATING,
INACTIVE,
FAILED,
UPDATING,
SCALED_TO_ZERO,
WAKING_UP
active_replica_count
integer
required

Number of active replicas

autoscaling_settings
object | null
required

Autoscaling settings for the deployment. If null, the model has not finished deploying

environment
string | null
required

The environment associated with the deployment