---
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 `200`

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

## Changes

- **2025-05-10** `f0c71f38bf3f` — 1 info
  - added the required property `metadata/localSubdomain` to the response with the `200` status
- **2025-05-09** `0db10235cd0a` — 1 info
  - added the success response with the status `200`
- **2025-05-08** `2084c6c64d17` — 1 info
  - added the required property `app/pendingRestart` to the response with the `200` status

[Change 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/bbfb40907c3c/schema)