---
title: "POST /settings/custom-relays"
method: POST
path: "/settings/custom-relays"
tags: ["settings"]
---

# POST /settings/custom-relays

`POST /settings/custom-relays`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in query parameter `auth`
  - API key in header `Authorization`

## Request body

- union: One item-scoped custom relay mutation.
  - object
    - `action` 'add', required
    - `credential` union, required
      - object
        - `action` 'keep', required
      - object
        - `accessToken` string, required
        - `action` 'set', required
      - object
        - `action` 'delete', required
    - `url` string, required
  - object
    - `action` 'edit', required
    - `credential` union, required
      - object
        - `action` 'keep', required
      - object
        - `accessToken` string, required
        - `action` 'set', required
      - object
        - `action` 'delete', required
    - `previousUrl` string, required
    - `url` string, required
  - object
    - `action` 'delete', required
    - `url` string, required

## Response `200`

Custom relay mutation applied

- CustomRelayMutationResultEnvelope: Canonical success envelope: `{ "data": T, "ts": <unix millis i64> }`. `ts` is `chrono::Utc::now().timestamp_millis()`, set in the webserver handler via [`ApiEnvelope::now`] (the contract carries only the type + the clock helper, not a hard dependency on when the handler reads the clock). `rename_all = "camelCase"` is a no-op for the single-word fields here but is declared for forward-compat. IMPORTANT (utoipa v4): every concrete `ApiEnvelope<X>` that needs a named OpenAPI component is declared in the `#[aliases(...)]` block below. Add a new alias line whenever a new payload type needs enveloping. NEVER register the bare `ApiEnvelope` in `components(schemas(...))` — utoipa errors on a bare generic, and an un-aliased generic inlines an anonymous schema.
  - `data` CustomRelayMutationResultDto, required
    - `relays` CustomRelayDto[], required
      - `credentialConfigured` boolean, required
      - `url` string, required
    - `restartRequired` boolean, required
  - `ts` integer, required: Server time when the response was built (unix epoch milliseconds).

## Other responses

- `400`: Invalid relay URL
- `404`: Relay no longer exists
- `409`: Relay already exists
- `500`: Relay mutation failed
- `503`: Credential storage unavailable

## Changes

- **2026-10-15** `4c664cabd0c5`: 5 info
  - added the optional property `requestId` to the response with the `400` status
  - added the optional property `requestId` to the response with the `404` status
  - added the optional property `requestId` to the response with the `409` status
  - added the optional property `requestId` to the response with the `500` status
  - …1 more
- **2026-09-20** `7c91adaf5548`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/changes/settings/custom-relays/post.md)

---

[API](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api.md) - [All operations](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/revisions/48a01cf04e4c?raw)