hosting

PUT `/v1/sites/{siteId}/directory-index`

Set a site's index files, its folder listing, or both.

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 PUT https://api.zinndigital.com/v1/sites/{siteId}/directory-index \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

⛔ **An omitted field means *leave it alone*.** Each control sends only itself: resending `files` alongside a listing change would write back a list the screen may have rendered from a stale read and clobber an edit somebody else made. A body with neither field is a no-op, not an error. Turning folder listing **on** publishes the names of every file in any folder with no index page, which on a site with backups or exports in the document root is a disclosure — so the client says that before calling. The whole new state is returned either way. `404` for a site with no managed hosting package. Requires `sites.view` and `sites.panel_access`.

Parametri

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

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`files`	`string[]`	No	The index file names, in the order the server tries them. Plain file names only — a path or a wildcard is refused `422` before the vendor is called. Omit to leave the current li…
`listing_enabled`	`boolean`	No	Whether a folder with no index file lists its contents. Omit, or send null, to leave it untouched.

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`files`	`string[]`	Sì	The index file names, in the order the server tries them.
`listing_enabled`	`boolean`	Sì	Whether a folder with no index file lists its contents. Null when the vendor does not report it — distinct from `false`, because a switch rendered from an unknown lies about…
`permitted`	`boolean`	Sì	Whether the package type includes the directory-index controls.

Errori che questo endpoint può restituire

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

PUT /v1/sites/{siteId}/directory-index