hosting

POST /v1/private-network/devices

Enrol a device and return its configuration once.

Všechny koncové body hosting

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/private-network/devices \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "label": <string> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

Gated on `network.private.manage` in addition to `sites.view`. ⛔⛔ **The `config` in the response is shown ONCE and can never be retrieved again.** The private key is generated in memory and is never stored — not in the database and not in Vault — so there is no endpoint that could return it a second time. A customer who loses it rotates the device, which is the correct handling of a lost secret. 422 when the device allowance is spent, when the label is blank, or when the organisation's dedicated address has not finished being assigned.

Tělo požadavku

NázevTypPožadovánoCo to je
labelstringAno

Odpověď

NázevTypPožadovánoCo to je
seatPrivateNetworkDeviceAno
configstringAnoThe complete WireGuard configuration file. ⛔⛔ Returned ONCE, on this response only. It contains the device's private key, which is generated in memory and never stored anywhere…

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422