hosting

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

Password-protect a folder on a site.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění sites.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.

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/sites/{siteId}/protection/directories \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "directory": <string>, "username": <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

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.

Parametry

Název	Typ	Požadováno	Co to je
`siteId (path)`	`Uuid`	Ano	Site ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`directory`	`string`	Ano	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`	Ano	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`	Ne	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…

Odpověď

Název	Typ	Požadováno	Co to je
`directory`	`SiteProtectedDirectory`	Ano	The folder, exactly as `getSiteProtection` will report it.
`password`	`string`	Ano	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 written…

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

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

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