v22

latestOpenAPI 3.1.0raw.githubusercontent.com2025-10-15361989.5 KB

Update a deployment

Update properties of an existing deployment, including hardware, min/max instances, and the deployment's underlying model version.

Example cURL request:

curl -s \
  -X PATCH \
  -H "Authorization: Bearer $REPLICATE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"min_instances": 3, "max_instances": 10}' \
  https://api.replicate.com/v1/deployments/acme/my-app-image-generator

The response will be a JSON object describing the deployment:

{
  "owner": "acme",
  "name": "my-app-image-generator",
  "current_release": {
    "number": 2,
    "model": "stability-ai/sdxl",
    "version": "da77bc59ee60423279fd632efb4795ab731d9e3ca9705ef3341091fb989b7eaf",
    "created_at": "2024-02-15T16:32:57.018467Z",
    "created_by": {
      "type": "organization",
      "username": "acme",
      "name": "Acme Corp, Inc.",
      "avatar_url": "https://cdn.replicate.com/avatars/acme.png",
      "github_url": "https://github.com/acme"
    },
    "configuration": {
      "hardware": "gpu-t4",
      "min_instances": 3,
      "max_instances": 10
    }
  }
}

Updating any deployment properties will increment the number field of the current_release.

patch/deployments/{deployment_owner}/{deployment_name}

Path parameters

deployment_ownerstring required

The name of the user or organization that owns the deployment.

deployment_namestring required

The name of the deployment.

Request body

hardwarestring

The SKU for the hardware used to run the model. Possible values can be retrieved from the hardware.list endpoint.

max_instancesinteger

The maximum number of instances for scaling.

min_instancesinteger

The minimum number of instances for scaling.

versionstring

The ID of the model version that you want to deploy

Response

Success

namestring

The name of the deployment.

ownerstring

The owner of the deployment.