---
title: "Get a computer by name"
method: GET
path: "/api/v0/computers/name/{name}"
tags: ["Computers"]
---

# Get a computer by name

`GET /api/v0/computers/name/{name}`

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

## Path parameters

- `name` string, required — Computer name

## Query parameters

- `serviceAccountId` string — Look up a service account’s Computers (requires human Manager+).
- `includeProvisioningSteps` 'true' | 'false' — Whether to include provisioning step details.

## Response `200`

Response for status 200

- GetComputerByName200ResponseBody
  - `id` string, required
  - `hostId` string, uuid
  - `name` string, required
  - `isListed` boolean
  - `providerType` string, required — Compute provider backing this computer, e.g. 'byom' or 'e2b'.
  - `status` 'provisioning' | 'active' | 'error'
  - `createdAt` number, required
  - `provisioningSteps` object[]
    - `id` string, required
    - `name` string, required
    - `status` string, required
    - `error` string
    - `startedAt` number
    - `completedAt` number
    - `installSessionId` string
  - `relayClientUrl` string, uri
  - `relayAgentUrl` string, uri
  - `relayIdentity` object
    - `publicKey` string, required
    - `keyId` string, required
    - `algorithm` 'Ed25519', required
    - `updatedAt` number, required
  - `remoteUser` string
  - `clonedRepoDirectories` string[]
  - `ownerPrincipalKind` string
  - `ownerId` string
  - `computerSource` union
    - object
      - `kind` 'template', required
      - `templateId` string, required
    - object
      - `kind` 'execution-template', required
      - `templateId` string, required
    - object
      - `kind` 'computer', required
      - `computerId` string, required

## Other responses

- `401` — Response for status 401
- `402` — Response for status 402
- `403` — Response for status 403
- `404` — Response for status 404
- `500` — Response for status 500

## Changes

- **2026-09-23** `4c7a84680cd4` — 1 info
  - added the optional property `relayIdentity` to the response with the `200` status
- **2026-09-15** `2b31c104e8d7` — 4 info
  - added the new optional `query` request parameter `includeProvisioningSteps`
  - added the new optional `query` request parameter `serviceAccountId`
  - added the non-success response with the status `402`
  - added the non-success response with the status `403`
- **2026-08-12** `5ee8657e0932` — 1 info
  - added `subschema #2` to the `computerSource` response property `anyOf` list for the response status `200`
- **2026-08-05** `b702af89bbff` — 1 info
  - added the optional property `isListed` to the response with the `200` status
- **2026-07-26** `749e76236673` — 2 info
  - removed the `byom` enum value from the `providerType` response property for the response status `200`
  - removed the `e2b` enum value from the `providerType` response property for the response status `200`

[Change history](https://skmtc.dev/factory/apis/factory-public-api/changes/api/v0/computers/name/:name/get.md)

---

[API](https://skmtc.dev/factory/apis/factory-public-api.md) · [All operations](https://skmtc.dev/factory/apis/factory-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factory/apis/factory-public-api/revisions/a11cdfab8da6?raw)