---
title: "GET /api/apps/{urn}"
method: GET
path: "/api/apps/{urn}"
tags: ["Apps"]
---

# GET /api/apps/{urn}

`GET /api/apps/{urn}`

## Path parameters

- `urn` string, required

## Response `default`

- GetAppDto
  - `info` object, required
    - `author` string, required
    - `available` boolean, required
    - `categories` string[], required
    - `created_at` integer, required
    - `deprecated` boolean, required
    - `description` string, required
    - `dynamic_config` boolean, required
    - `exposable` boolean, required
    - `force_expose` boolean, required
    - `force_pull` boolean, required
    - `form_fields` object[], required
      - `env_variable` string, required
      - `label` string, required
      - `required` boolean, required
      - `type` 'boolean' | 'email' | 'fqdn' | 'fqdnip' | 'ip' | 'number' | 'password' | 'random' | 'text' | 'url', required
      - `default` union
        - number
        - string
        - boolean
      - `encoding` 'base64' | 'hex'
      - `hint` string
      - `max` number
      - `min` number
      - `options` object[]
        - `label` string, required
        - `value` string, required
      - `pattern_error` string
      - `placeholder` string
      - `regex` string
    - `generate_vapid_keys` boolean, required
    - `https` boolean, required
    - `id` string, required
    - `name` string, required
    - `no_gui` boolean, required
    - `short_desc` string, required
    - `source` string, required
    - `supported_architectures` string[], required
    - `tipi_version` number, required
    - `updated_at` integer, required
    - `urn` string, required
    - `version` string, required
    - `gid` number
    - `min_tipi_version` string
    - `port` number
    - `uid` number
    - `url_suffix` string
    - `website` string
  - `metadata` object, required
    - `latestVersion` number, required
    - `localSubdomain` string, required
    - `composeSchemaVersion` number
    - `hasCustomConfig` boolean
    - `latestDockerVersion` string
    - `minTipiVersion` string, nullable
  - `app` object, nullable
    - `createdAt` number, required
    - `domain` string, nullable, required
    - `exposed` boolean, required
    - `exposedLocal` boolean, required
    - `id` number, required
    - `ignoredVersion` number, nullable, required
    - `isVisibleOnGuestDashboard` boolean, required
    - `openPort` boolean, required
    - `pendingRestart` boolean, required
    - `port` number, nullable, required
    - `status` 'backing_up' | 'installing' | 'missing' | 'resetting' | 'restarting' | 'restoring' | 'running' | 'starting' | 'stopped' | 'stopping' | 'uninstalling' | 'updating', required
    - `templateUrn` string, nullable, required
    - `updatedAt` number, required
    - `version` number, required
    - `config` object
    - `enableAuth` boolean
    - `localSubdomain` string, nullable

## Changes

- **2026-03-06** `87821b08d809` — 1 info
  - added the required property `app/anyOf[subschema #1]/templateUrn` to the response with the `default` status
- **2025-11-11** `4cecb3c8a108` — 2 breaking, 2 info
  - the `app/anyOf[subschema #1]/createdAt` response's property type changed from `string` to `number` for status `default`
  - the `app/anyOf[subschema #1]/updatedAt` response's property type changed from `string` to `number` for status `default`
  - the response property `app/anyOf[subschema #1]/createdAt` became required for the status `default`
  - the response property `app/anyOf[subschema #1]/updatedAt` became required for the status `default`
- **2025-11-01** `cf9b3d6583fb` — 1 info
  - added the required property `app/anyOf[subschema #1]/ignoredVersion` to the response with the `default` status
- **2025-10-24** `2651941f89c8` — 2 info
  - added the optional property `metadata/composeSchemaVersion` to the response with the `default` status
  - response property `info/port` list-of-types was narrowed by removing types `string` from media type `application/json` of response `default`
- **2025-10-18** `b488b0059333` — 1 breaking
  - response property `info/port` list-of-types was widened by adding types `string` to media type `application/json` of response `default`

[Full history](https://skmtc.dev/runtipi/apis/runtipi-api/changes/api/apps/:urn/get.md)

---

[API](https://skmtc.dev/runtipi/apis/runtipi-api.md) · [All operations](https://skmtc.dev/runtipi/apis/runtipi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runtipi/runtipi-api/revisions/5c7deb969194/schema)