hosting

POST `/v1/sites/{siteId}/ssh-keys`

Authorise a public key for SSH on a site.

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione sites.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ssh-keys \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "handle": <string>, "key": <string> }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

Files one public key under a handle and returns the key as it was stored. `201` and the created key rather than the whole list, because the list is re-read anyway: `can_create` is a property of the collection and the vendor's own key count moves with it. ⛔ **What makes a key valid is checked in the service, not in this schema**, and the sentence the customer reads is the same whichever door they came through — including the one that says *"that is your private key"*. A line that is not a public key we accept, a handle outside `[A-Za-z0-9][A-Za-z0-9._-]{0,63}`, a duplicate handle, or a package type that does not include SSH are all `422` with our wording, before the vendor is called. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `sites.view` **and** `sites.panel_access` — this write grants a shell.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`siteId (path)`	`Uuid`	Sì	Site ID (UUIDv7).

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`handle`	`string`	Sì	What to file the key under. Constrained to `[A-Za-z0-9][A-Za-z0-9._-]{0,63}`; anything else is refused with our wording rather than the vendor's.
`key`	`string`	Sì	The public key line, as OpenSSH writes it.

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`handle`	`string`	Sì	The name the key is filed under, ours and the vendor's, and what `deleteSiteSshKey` addresses. Constrained to `[A-Za-z0-9][A-Za-z0-9._-]{0,63}`.
`key`	`string`	Sì	The public key line, in full and never truncated. It is a public key — publishing it is what it is for — and a shortened one would stop a customer confirming that the key on…
`algorithm`	`string`	Sì	The key type parsed out of the line. `""` when the stored line does not parse as one of the algorithms we accept, which is possible for a key added at the vendor before this sur…
`comment`	`string`	Sì	The trailing comment on the key line. Often an email address, often empty.

Errori che questo endpoint può restituire

401 · 403 · 404 · 422 · 429 · 503

POST /v1/sites/{siteId}/ssh-keys