Computers

Update a computer

Changed on

Updates a computer's name, remote user, or relay identity. A host ID can be assigned to a computer that does not have one; host IDs are immutable once set and must be unique among the owner's computers.

patch/api/v0/computers/{computerId}

Request

  • Base URL: https://api.factory.ai
  • URL: https://api.factory.ai/api/v0/computers/{computerId}
  • Auth: HTTP bearer

Path parameters

computerIdstring required

Computer ID

Request body

namestring
hostIdstring uuid
remoteUserstring

Response

Response for status 200

idstring required
hostIdstring uuid
namestring required
isListedboolean
providerTypestring required

Compute provider backing this computer, e.g. 'byom' or 'e2b'.

status'provisioning' | 'active' | 'error'
createdAtnumber required
relayClientUrlstring uri
relayAgentUrlstring uri
remoteUserstring
clonedRepoDirectoriesstring[]
ownerPrincipalKindstring
ownerIdstring

Changes

  • dd43fbb08a00Revision changes
    • info

      added the non-success response with the status

  • efe9fecba869Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status