Update worker

Renames a worker, but only when the caller is the user who originally created that worker.

PATCH /v1/workers/{id}

Update worker

cURL

curl --request PATCH \
  --url https://api.openworklabs.com/v1/workers/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

200

{
  "worker": {
    "id": "<string>",
    "orgId": "<string>",
    "createdByUserId": "<string>",
    "isMine": true,
    "name": "<string>",
    "description": "<string>",
    "destination": "<string>",
    "status": "<string>",
    "imageVersion": "<string>",
    "workspacePath": "<string>",
    "sandboxBackend": "<string>",
    "lastHeartbeatAt": "2023-11-07T05:31:56Z",
    "lastActiveAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

id · string<typeid> · required

Den TypeID with 'wrk_' prefix and a 26-character base32 suffix.

Required string length: 30

Pattern: ^wrk_.*

Body

application/json

name · string · required

Required string length: 1 - 255

Response

200

application/json

Worker updated successfully.

worker · object · required

Show child attributes