---
title: "Add a Tor `.onion` mirror to a running deployment"
method: POST
path: "/platform/deployments/{id}/onion/add"
tags: ["Platform"]
---

# Add a Tor \`.onion\` mirror to a running deployment

`POST /platform/deployments/{id}/onion/add`

## Request

- Base URL: `https://api.imprezahost.com/v1`
- URL: `https://api.imprezahost.com/v1/platform/deployments/{id}/onion/add`
- Auth: API key in header `X-API-Key` and API key in header `X-API-Secret`

Provisions a new Tor v3 hidden service for a deployment that is
currently running clearnet-only. The clearnet URL keeps
working — the `.onion` is added alongside.

Only available for apps whose manifest declares
`supports.onion: true` (the clientarea hides the button
otherwise; the API also enforces it).

## Path parameters

- `id` string, required

## Response `202`

Onion provisioning enqueued. The address arrives via the agent's deploy-result and shows up on the deployment row a few seconds later.

## Other responses

- `401`: Invalid or missing API credentials
- `404`: Resource not found
- `409`: Already has an onion, or not in running state.
- `422`: App manifest does not declare supports.onion=true.

---

[API](https://skmtc.dev/imprezahost/apis/impreza-host-public-api.md) · [All operations](https://skmtc.dev/imprezahost/apis/impreza-host-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/imprezahost/apis/impreza-host-public-api/revisions/db86511f604f?raw)