DocumentationAPI Reference
Deployments

Update deployment

PUT
/workspaces/{workspaceId}/deployment-cohorts/{deploymentCohortId}/deployments/{deploymentId}

Authorization

API key Deployments: write
AuthorizationBearer <token>

API key (sf_...) with any of the required scopes. Generate it in the Spotflow portal on the settings page.

In: header

Scope: Deployments: write

Path Parameters

workspaceId*string
Formatuuid
deploymentCohortId*string
deploymentId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Response Body

application/json

application/problem+json

application/problem+json

curl -X PUT "https://example.com/workspaces/00000000-0000-0000-0000-000000000001/deployment-cohorts/m3Yg84tDx7Rn/deployments/p6Bh19qSj5Fw" \  -H "Content-Type: application/json" \  -d '{    "name": "Roll out 2.4.1 (EU)"  }'

Updated deployment.

{  "id": "p6Bh19qSj5Fw",  "name": "Roll out 2.4.1",  "deploymentCohortId": "m3Yg84tDx7Rn",  "createdAt": "2026-01-12T09:00:00+00:00",  "isActive": true,  "artifacts": [    {      "id": "s4Jm62wQb7Nz",      "order": 0,      "firmware": {        "isMain": true,        "slug": "main-application",        "firmwareVersion": {          "id": "r2Kt75mXc8Vd",          "name": "2.4.1",          "firmware": {            "id": "q8Fd53pLn1Yr",            "name": "Thermostat application"          }        }      }    }  ],  "deviceUpdateStateCounts": {    "pending": 4,    "inProgress": 2,    "succeeded": 17,    "failed": 1,    "cancelled": 0  }}