Platform

Add or replace an authorized client

Tor v3 restricted discovery: submit a locally generated X25519 public key (base32, 52 chars), or generate: true to have one minted — the private key is returned ONCE and never stored. Every client-list change restarts the host's shared Tor daemon briefly (invalidating existing rendezvous state is the point); onion connections for other apps on the same server may blip while containers keep running. Revoking the last client makes the service public again. Requires the manage scope and an agent announcing onion-auth-v1.

post/platform/deployments/{id}/onion/clients

Request

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

Path parameters

idstring required

Request body

namestring required
pubkeystring

Base32 X25519 public key (52 chars). Mutually exclusive with generate.

generateboolean

Mint a keypair server-side; the private key is displayed exactly once.

Response

Client authorized; an onion_auth_update command carries the full active list.

Changes

No recorded changes to this operation across all 1 revision of this API.