hosting

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

Authorise a public key for SSH on a site.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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 הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429 · 503

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