Edit Deployment

POSThttps://{organization}.blackbox.ai/dedicated/edit

Update the scaling policy, description, or enabled state of an existing deployment.

Patch mutable fields on an existing deployment. Only fields present in patch are updated; the rest are left unchanged. GPU type, GPU count, region, and the underlying template are immutable — recreate the deployment to change them.

Headers

Authorizationstringrequired

API Key of the form Bearer <api_key>. Must own the deployment.

Content-Typestringrequired

Must be set to application/json.

Request Body

deployment_idstringrequired

UUID of the deployment to update. Get this from POST /dedicated/create-deployment or GET /dedicated/list.

patchobjectrequired

Fields to update.

Patch Object

scalingobject

New autoscaling policy. Same shape as on create: { min_replicas, max_replicas }.

descriptionstring

Replacement description (≤512 characters). Pass an empty string to clear.

enabledboolean

Set to false to pause request routing to the deployment without deleting it; true to resume.

Response

Returns the updated deployment object — same shape as the response from POST /dedicated/create-deployment.

deployment_idstring

UUID of the deployment.

modelstring

Client-facing model id.

model_namestring

Template name the deployment was created from.

statusstring | null

Current lifecycle status.

scalingobject

Effective scaling policy after the update.

descriptionstring | null

Description after the update.

created_atstring

ISO 8601 timestamp of creation.

updated_atstring

ISO 8601 timestamp of this update.

Request Example

curl -X POST https://{organization}.blackbox.ai/dedicated/edit \
  -H "Authorization: Bearer $BLACKBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "deployment_id": "9c8b7a6d-5e4f-3a2b-1c0d-ef1234567890",
    "patch": {
      "scaling": { "min_replicas": 0, "max_replicas": 8 },
      "description": "Scaled up for launch week"
    }
  }'

import os
import requests

response = requests.post(
    "https://{organization}.blackbox.ai/dedicated/edit",
    headers={
        "Authorization": f"Bearer {os.environ['BLACKBOX_API_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "deployment_id": "9c8b7a6d-5e4f-3a2b-1c0d-ef1234567890",
        "patch": {
            "scaling": {"min_replicas": 0, "max_replicas": 8},
            "description": "Scaled up for launch week",
        },
    },
)

print(response.json())

const response = await fetch("https://{organization}.blackbox.ai/dedicated/edit", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BLACKBOX_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    deployment_id: "9c8b7a6d-5e4f-3a2b-1c0d-ef1234567890",
    patch: {
      scaling: { min_replicas: 0, max_replicas: 8 },
      description: "Scaled up for launch week",
    },
  }),
});

const data = await response.json();
console.log(data);

Response Example

{
  "deployment_id": "9c8b7a6d-5e4f-3a2b-1c0d-ef1234567890",
  "model": "dedicated/openai/gpt-oss-20b-Ab3xY9K1mN2p",
  "model_name": "openai/gpt-oss-20b",
  "status": "running",
  "scaling": {
    "min_replicas": 0,
    "max_replicas": 8
  },
  "description": "Scaled up for launch week",
  "created_at": "2026-07-10T14:22:05Z",
  "updated_at": "2026-07-10T15:03:47Z"
}

Error Codes

Status	Error	Description
400	`invalid_request`	Missing `deployment_id`, empty `patch`, or invalid field values.
401	`unauthorized`	Missing or invalid API key.
404	`deployment_not_found`	No deployment with that id owned by the caller. Deployments are scoped by account — you cannot edit another user's deployment.