Update a computer

Updates a computer by ID.

PATCH /api/v0/computers/{computerId}

Update a computer

cURL

curl --request PATCH \
  --url https://api.factory.ai/api/v0/computers/{computerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "remoteUser": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "providerType": "byom",
  "createdAt": 123,
  "hostname": "<string>",
  "status": "provisioning",
  "provisioningSteps": [
    {
      "id": "create-computer",
      "name": "<string>",
      "status": "pending",
      "error": "<string>",
      "startedAt": 123,
      "completedAt": 123
    }
  ],
  "relayClientUrl": "<string>",
  "relayAgentUrl": "<string>",
  "remoteUser": "<string>"
}

承認

Authorization · string · header · 必須

Factory API key or JWT token for authentication

パスパラメータ

computerId · string · 必須

Computer ID

ボディ

application/json

name · string

Required string length: 1 - 63

remoteUser · string

Required string length: 1 - 63

レスポンス

200

application/json

Response for status 200

id · string · 必須

name · string · 必須

providerType · enum<string> · 必須

利用可能なオプション: byom, e2b

createdAt · number · 必須

hostname · string

status · enum<string>

利用可能なオプション: provisioning, active, error

provisioningSteps · object[]

Show child attributes

relayClientUrl · string<uri>

relayAgentUrl · string<uri>

remoteUser · string