---
title: "Latest and minimum supported version of every Shardflux client"
method: GET
path: "/v1/client-versions"
tags: ["Client versions"]
---

# Latest and minimum supported version of every Shardflux client

`GET /v1/client-versions`

## Request

- Base URL: `https://api.shardflux.dev`
- URL: `https://api.shardflux.dev/v1/client-versions`
- Auth: none declared

Unauthenticated, `Cache-Control: public, max-age=3600`. Clients compare their own version: below `minimum_supported` they are unsupported, below the latest release outdated. Current clients take the latest release from the package registry (npm `latest`, PyPI) and use `latest` here as the fallback; `hold` names a release they stop recommending. They check at most every 12 hours (the CLI) or once per process (the SDKs), in the background, and never fail because of it.

## Response `200`

Default Response

- object
  - `clients` object[], required
    - `package` string, required: Registry package name, e.g. `@shardflux/cli`; with `ecosystem` it names one client.
    - `ecosystem` union, required
      - 'npm'
      - 'pypi'
    - `latest` string, nullable, required: Latest published version; null while the package is not distributed (clients stay silent).
    - `minimum_supported` string, required: Oldest version this API still serves correctly; older clients should tell their user to update.
    - `upgrade_command` string, required
    - `release_notes_url` string, required
    - `hold` string, nullable: A published version clients stop recommending (an emergency brake; clients 0.15.2+ / SDK 0.22.0+ take `latest` from the registry and skip this one). Null or absent: none.

## 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)