ULultralytics
Deployments

Update a deployment

Changed on

Renames the deployment and its Platform URL slug, updates custom metadata, starts, stops, resizes, or rolls out another model. The Cloud Run service URL is preserved. Renaming invalidates existing Platform URL references, including calls from active workflows. The camera action saves an RTSP/RTSPS URL for always-on inference on a paid endpoint, or removes it with url null.

patch/api/deployments/{owner}/{deployment}

Request

  • Base URL
    https://platform.ultralytics.com
  • Auth
    HTTP bearer

Path parameters

ownerstring required
Example:ultralytics

Deployment owner

deploymentstring required
Example:yolo26-api

Deployment name

Request body

OR
OR

Example request

{
  "project": "yolo26",
  "model": "yolo26n"
}

Response

Deployment updated

successtrue required
status'creating' | 'deploying' | 'ready' | 'stopping' | 'stopped' | 'failed' required

Dedicated deployment lifecycle status

messagestring required
deploymentstring

Deployment slug after renaming

Changes

  • 3c8e433f2c58Revision changes
    • warning

      added the new ready enum value to the response property for the response status

    • info

      added subschema #3 to the request property oneOf list

  • db12a94081aaRevision changes
    • info

      added the optional property to the response with the status