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>",
  "hostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remoteUser": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": 123,
  "hostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hostname": "<string>",
  "provisioningSteps": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "error": "<string>",
      "startedAt": 123,
      "completedAt": 123,
      "installSessionId": "<string>"
    }
  ],
  "relayClientUrl": "<string>",
  "relayAgentUrl": "<string>",
  "remoteUser": "<string>"
}

Authorizations

Authorization · string · header · required

Factory API key or JWT token for authentication

Path Parameters

computerId · string · required

Computer ID

Body

application/json

name · string

Required string length: 1 - 63

hostId · string<uuid>

remoteUser · string

Required string length: 1 - 63

Response

200

application/json

Response for status 200

id · string · required

name · string · required

providerType · enum<string> · required

Available options: byom, e2b

createdAt · number · required

hostId · string<uuid>

hostname · string

status · enum<string>

Available options: provisioning, active, error

provisioningSteps · object[]

Show child attributes

relayClientUrl · string<uri>

relayAgentUrl · string<uri>

remoteUser · string