---
title: "Get Xcode instance with given ID"
method: GET
path: "/v1/xcode_instances/{id}"
---

# Get Xcode instance with given ID

`GET /v1/xcode_instances/{id}`

## Path parameters

- `id` string, required

## Response `200`

OK

- XcodeInstance
  - `metadata` object, required
    - `id` string, required
    - `displayName` string
    - `organizationId` string, required
    - `createdAt` string, date-time, required
    - `terminatedAt` string, date-time
    - `labels` object
  - `spec` object, required
    - `region` string, required
    - `inactivityTimeout` string, duration, required
    - `hardTimeout` string, duration
  - `status` object, required
    - `state` 'unknown' | 'creating' | 'assigned' | 'ready' | 'terminated', required
    - `apiUrl` string
    - `token` string, required
    - `errorMessage` string
    - `terminationReason` string — Machine-readable reason the instance was terminated. Always present once state is "terminated", never present before that. New values may be added over time, so treat any unrecognized value as "Unknown". Known values: - "UserRequested": terminated by a delete request to the API. - "InactivityTimeout": the timeout given in spec.inactivityTimeout elapsed. - "HardTimeout": the timeout given in spec.hardTimeout elapsed. - "Unknown": terminated for a cause the platform did not attribute, including instances that failed to get ready during creation. See errorMessage for details when available.

## Other responses

- `default` — Error

---

[API](https://skmtc.net/limrun-inc/apis/limrun-api.md) · [All operations](https://skmtc.net/limrun-inc/apis/limrun-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/limrun-inc/limrun-api/versions/0a3cd7959546/schema)