hosting

POST /v1/sites/{siteId}/ssl

Request the free certificate for a site.

Svi hosting krajnji točke

Sva developerska dokumentacija

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu sites.view; ključ bez nje se odbija s kodom 403, a ne 404.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ssl \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

Asks the vendor to issue the free certificate the package includes, then returns the site's TLS state as getSiteSsl would. It returns 200 and the whole resource rather than 201 and a certificate, because issuance is not instant: what the customer needs back is the state of the thing they were looking at, and the certificate appears in it once the authority has answered. Issuing again while a certificate is already valid is not an error — the request is safe to repeat, which matters because the customer's most likely next action after seeing nothing happen is to press the button again. A package type that does not permit free certificates is refused 422 before the vendor is called, with our sentence rather than a vendor error string. 404 for a site with no vendor hosting package, exactly as getSiteHosting. Requires sites.view and hosting.ssl.manage.

Parametri

NazivVrstaObaveznoŠto je to
siteId (path)UuidDaSite ID (UUIDv7).

Odgovor

NazivVrstaObaveznoŠto je to
availablebooleanDaWhether the package type exposes a certificate surface at all. False renders an explanation rather than an empty list, so "nothing has been issued yet" and "not part of this plan"…
certificatesSiteSslCertificate[]DaThe certificates installed on the package.
force_httpsbooleanDaWhether plain HTTP is redirected to HTTPS, or null when the package does not report the setting. Null is a third state the client must render as unknown: an unchecked toggle would…
free_ssl_permittedbooleanDaWhether this package type permits requesting the free certificate. An absent vendor capability means refused, never "probably on" — the refusal is ours, in our words, before…
force_ssl_permittedbooleanDaWhether this package type permits changing HTTPS enforcement.
external_ssl_permittedbooleanDaWhether this package type permits installing a certificate the customer obtained elsewhere (installSiteExternalSsl). Reported separately from free_ssl_permitted because they…

Pogreške koje ova krajnja točka može vratiti

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