hosting

POST `/v1/sites/{siteId}/protection/directories`

Password-protect a folder on a site.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь sites.view эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.

Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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

Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх

Дэлгэрэнгүй

Puts an HTTP password on one folder under the document root. `POST` and not a `PUT` of the whole set even though the vendor endpoint replaces it: the set is rebuilt by the engine from the entries the platform itself returned, precisely because we do not hold the other folders' passwords and must not ask a customer to re-enter them to protect a new one. ⛔ **The response carries a password, and it is the only one on this surface that does.** Omit `password` and the engine generates a strong one; either way the value is returned **exactly once**, written to no record of ours, and readable back by no endpoint. The whole response is therefore a credential: a client displays it once and does not cache it, store it in a query cache, put it in a URL, or include it in an error report. `username` may not contain a colon or a space — `:` separates the name from the hash in an `.htpasswd` file, so a name containing one produces a file that parses into something other than what was written. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.

Параметрүүд

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`siteId (path)`	`Uuid`	Тийм	Site ID (UUIDv7).

Хүсэлтийн бие

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`directory`	`string`	Тийм	The folder to protect, relative to the document root. It is normalised before it is compared with what the vendor holds, so what is protected is the folder the customer meant.
`username`	`string`	Тийм	The name a visitor types. No colon and no space, because this is written into an `.htpasswd` file where `:` is the field separator.
`password`	`string`	Үгүй	Optional. Omitting it means generate one for me, which is the path that guarantees a strong value. Write-only: whatever is sent here appears in no response, no log line and no…

Хариу үйлдэл

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`directory`	`SiteProtectedDirectory`	Тийм	The folder, exactly as `getSiteProtection` will report it.
`password`	`string`	Тийм	The password, shown once. Deliberately carries no example — a documented example of a credential field is the shape people copy. ⛔ It never contains a colon: this value is writt…

Энэ төгсгөл цэгээс буцааж болох алдаанууд

401 · 403 · 404 · 409 · 422 · 429 · 503

POST /v1/sites/{siteId}/protection/directories