hosting

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

Authorise a public key for SSH on a site.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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> }'

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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.

Параметри

Име	Тип	Задължително	Какво представлява
`siteId (path)`	`Uuid`	Да	Site ID (UUIDv7).

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`handle`	`string`	Да	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`	Да	The public key line, as OpenSSH writes it.

Отговор

Име	Тип	Задължително	Какво представлява
`handle`	`string`	Да	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`	Да	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`	Да	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…
`comment`	`string`	Да	The trailing comment on the key line. Often an email address, often empty.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429 · 503

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