Computers

Get a computer by name

Changed on

Returns the caller's computer by name, or a service account's computer when requested by a human Manager or higher.

get/api/v0/computers/name/{name}

Request

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

Path parameters

namestring required

Computer name

Query parameters

serviceAccountIdstring

Look up a service account’s Computers (requires human Manager+).

includeProvisioningSteps'true' | 'false'

Whether to include provisioning step details.

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 optional property from the response with the status

    • info

      added the optional property to the response with the status