---
title: "Runtime version and upgrade options"
method: GET
path: "/app/{id}/runtime-version"
tags: ["apps"]
---

# Runtime version and upgrade options

`GET /app/{id}/runtime-version`

## Request

- Base URL: `https://api.faable.com`
- URL: `https://api.faable.com/app/{id}/runtime-version`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://faable.auth.faable.link/authorize`, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - HTTP basic
  - API key in query parameter `apikey`

The app's sticky runtime version (pin), and the versions it could move to — the data behind the upgrade button.

## Path parameters

- `id` string, required

## Response `200`

Default Response

- object
  - `name` string, required
  - `pinned` object, required
    - `name` string, required
    - `version` string, required
    - `pinned_at` string, date-time, required
    - `source` string, required
  - `repo_pin` string, required
  - `current` string, required
  - `available` string[], required
  - `newest` string, required
  - `retiring` object, required
    - `retire_at` string, required
    - `replacement` string, required
    - `why` string, required
  - `last_upgrade` object, required
    - `deployment_id` string, required
    - `to` string, required
    - `from` string, required
    - `phase` string, required
    - `created_at` string, date-time, required

## Other responses

- `400`: `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
- `401`: `unauthorized` — The request carries no valid credentials. `invalid_token` — The bearer token is missing, malformed or expired.
- `403`: `forbidden` — The credentials are valid but do not allow this operation. `user_suspended` — The account is suspended. Contact support@faable.com.
- `429`: `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header.
- `500`: `internal_error` — Unexpected server error. Retry later; the request id is logged.
- `503`: `database_unavailable` — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.

---

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