---
title: "Get your machine filesystem"
method: GET
path: "/v1/machine"
tags: ["Agent environments"]
---

# Get your machine filesystem

`GET /v1/machine`

## Request

- Base URL: `https://api.shardflux.dev`
- URL: `https://api.shardflux.dev/v1/machine`
- Auth: HTTP bearer

## Query parameters

- `project_id` string, uuid
- `repo_remote` string

## Response `200`

Default Response

- object
  - `level` union, required
    - 'machine'
    - 'template'
  - `organization_id` string, uuid, required: UUIDv7, lowercase canonical form.
  - `project_id` string, uuid: UUIDv7, lowercase canonical form.
  - `repo_remote` string
  - `version` integer, required
  - `state` union, required
    - 'empty'
    - 'building'
    - 'ready'
    - 'failed'
  - `workspace_id` string, uuid: UUIDv7, lowercase canonical form.
  - `updated_at` string, date-time: RFC 3339 UTC timestamp with Z.
  - `members` integer: Machine only: how many members the organization has. Every member's new conversations start from this machine, so a client folds a user's personal agent config into it only while that user is the only member.
  - `template` object
    - `slug` string, required
    - `version` integer, required
  - `pending` object
    - `version` integer, required
    - `build_id` string, uuid, required: UUIDv7, lowercase canonical form.
  - `machine_version` integer
  - `platform_base` object
    - `slug` string, required
    - `version` integer, required
  - `rebase_pending` boolean
  - `rebase_deferred` boolean: Project templates only, with rebase_pending: no conversation, VM or save used this template for 30 days, so it is rebuilt on its machine when the next one starts, and that VM moves onto the rebuilt version at its next safe point.
  - `failure` object
    - `version` integer, required
    - `message` string, required
    - `code` string: The save build's failure.code (e.g. resource_limit, build_error); absent when its build was canceled.
    - `retryable` boolean: Whether saving the same VM again can succeed. false for resource_limit, scan_failed and the immutable path codes: change the VM (or the plan) first.
    - `details` object: The build failure's details. resource_limit: {limit, value, actual}; template_org_bytes_max compares the version's size (actual) with the plan's workspace disk (value), in bytes.
  - `volumes` object[], required
    - `id` string, uuid, required
    - `volume_id` string, uuid, required
    - `name` string, required
    - `mount_path` string, required
    - `mode` union, required
      - 'ro'
      - 'rw'
    - `source` union, required
      - 'machine'
      - 'template'
  - `history` object[], required
    - `version` integer, required
    - `created_at` string, date-time, required: RFC 3339 UTC timestamp with Z.
    - `restored_from` integer
  - `moved_to_image` string[]: Save responses only: home folders this save put into the image, linked back at the same paths (e.g. ~/.dotnet).

## Other responses

- `4XX`: Default Response
- `5XX`: Default Response

---

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