---
title: "PATCH /api/custom-apps/{urn}"
method: PATCH
path: "/api/custom-apps/{urn}"
tags: ["CustomApp"]
---

# PATCH /api/custom-apps/{urn}

`PATCH /api/custom-apps/{urn}`

## Path parameters

- `urn` string, required

## Request body

- UpdateCustomAppDto
  - `config` object, required
    - `schemaVersion` unknown, required
    - `services` object[], required
      - `image` string, required
      - `internalPort` number, required
      - `name` string, required
      - `addPorts` object[]
        - `containerPort` number, required
        - `hostPort` number, required
        - `interface` string
        - `tcp` boolean
        - `udp` boolean
      - `addToMainNetwork` boolean
      - `capAdd` string[]
      - `capDrop` string[]
      - `command` union
        - string
        - string[]
      - `dependsOn` union
        - object
        - string[]
      - `deploy` object
        - `resources` object, required
          - `limits` object
            - `cpus` string
            - `memory` string
            - `pids` number
          - `reservations` object
            - `devices` object[], required
              - …
            - `cpus` string
            - `memory` string
      - `devices` string[]
      - `dns` union
        - string
        - string[]
      - `entrypoint` union
        - string
        - string[]
      - `environment` object[]
        - `key` string, required
        - `value` union, required
          - number
          - string
          - boolean
      - `extraHosts` string[]
      - `extraLabels` object
      - `healthCheck` object
        - `test` string, required
        - `interval` string
        - `retries` number
        - `startInterval` string
        - `startPeriod` string
        - `timeout` string
      - `hostname` string
      - `isMain` boolean
      - `logging` object
        - `driver` string, required
        - `options` object
      - `networkMode` string
      - `pid` string
      - `privileged` boolean
      - `readOnly` boolean
      - `securityOpt` string[]
      - `shmSize` string
      - `stdinOpen` boolean
      - `stopGracePeriod` string
      - `stopSignal` string
      - `sysctls` object
      - `tty` boolean
      - `ulimits` object
        - `core` union
          - number
          - object
            - `hard` number, required
            - `soft` number, required
        - `memlock` union
          - number
          - object
            - `hard` number, required
            - `soft` number, required
        - `nofile` union
          - number
          - object
            - `hard` number, required
            - `soft` number, required
        - `nproc` union
          - number
          - object
            - `hard` number, required
            - `soft` number, required
      - `user` string
      - `volumes` object[]
        - `containerPath` string, required
        - `hostPath` string, required
        - `private` boolean
        - `readOnly` boolean
        - `shared` boolean
      - `workingDir` string
    - `overrides` object[]
      - `services` object[], required
        - `addPorts` object[]
          - `containerPort` number, required
          - `hostPort` number, required
          - `interface` string
          - `tcp` boolean
          - `udp` boolean
        - `addToMainNetwork` boolean
        - `capAdd` string[]
        - `capDrop` string[]
        - `command` union
          - string
          - string[]
        - `dependsOn` union
          - object
          - string[]
        - `deploy` object
          - `resources` object, required
            - `limits` object
              - …
            - `reservations` object
              - …
        - `devices` string[]
        - `dns` union
          - string
          - string[]
        - `entrypoint` union
          - string
          - string[]
        - `environment` object[]
          - `key` string, required
          - `value` union, required
            - number
            - string
            - boolean
        - `extraHosts` string[]
        - `extraLabels` object
        - `healthCheck` object
          - `test` string, required
          - `interval` string
          - `retries` number
          - `startInterval` string
          - `startPeriod` string
          - `timeout` string
        - `hostname` string
        - `image` string
        - `internalPort` number
        - `isMain` boolean
        - `logging` object
          - `driver` string, required
          - `options` object
        - `name` string
        - `networkMode` string
        - `pid` string
        - `privileged` boolean
        - `readOnly` boolean
        - `securityOpt` string[]
        - `shmSize` string
        - `stdinOpen` boolean
        - `stopGracePeriod` string
        - `stopSignal` string
        - `sysctls` object
        - `tty` boolean
        - `ulimits` object
          - `core` union
            - number
            - object
              - …
          - `memlock` union
            - number
            - object
              - …
          - `nofile` union
            - number
            - object
              - …
          - `nproc` union
            - number
            - object
              - …
        - `user` string
        - `volumes` object[]
          - `containerPath` string, required
          - `hostPath` string, required
          - `private` boolean
          - `readOnly` boolean
          - `shared` boolean
        - `workingDir` string
      - `architecture` union
        - 'amd64'
        - 'arm64'

## Response `default`

## Changes

- **2025-09-30** `0fcd4e7364eb` — 1 info
  - endpoint added
- **2025-05-09** `0db10235cd0a` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/runtipi/apis/runtipi-api/changes/api/custom-apps/:urn/patch.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/0fcd4e7364eb/schema)