INTEGRITY Dokumentace

Běžná volání API

Jako poskytovatel SaaS možná budete chtít konfigurovat a spravovat Cloudflare for SaaS přes API namísto Cloudflare dashboard ↗. Níže jsou uvedena příslušná volání API pro vytváření, úpravu a odstraňování vlastních hostitelských názvů a také pro sledování, aktualizaci a odstraňování záložních origin serverů. Další podrobnosti najdete v Dokumentace Cloudflare API.


Vlastní hostitelské názvy

Endpoint Poznámky
Vypsat vlastní hostitelské názvy Použijte page parametr k načtení dalších stránek. Přidejte hostname parametr k vyhledání konkrétních hostitelských názvů.
Create custom hostname V validation_records objektu odpovědi použijte txt_name a txt_record uvedené k ověření vlastního hostname.
Custom hostname details Pomocí tohoto endpointu zkontrolujte aktivaci hostitelského názvu a stav certifikátu.
Úprava vlastního hostname Při odeslání s ssl objekt, který odpovídá stávající hodnotě, znamená, že hostitelský název má restartovat ověření kontroly domény (DCV).
Odstranění vlastního hostitelského názvu Zároveň se odstraní všechny přidružené certifikáty SSL/TLS.

Potvrzení připravenosti vlastního hostname

Chcete-li si ověřit, že je vlastní hostitelský název plně nakonfigurován, zkontrolujte obě stavová pole v Custom hostname details endpoint odpověď:

Pole API Co to znamená Hodnota Ready
result.status Stav aktivace hostname. Toto pole ukazuje, zda Cloudflare ověřil a aktivoval vlastní hostname. active
result.ssl.status Stav certifikátu. Toto pole udává, zda bylo u certifikátu SSL/TLS daného hostitelského názvu dokončeno vydání a nasazení. active

Vlastní hostitelský název považujte za připravený pro produkční HTTPS, pokud result.status je active, result.ssl.status je active, a DNS zákazníka směřuje na váš cíl CNAME nebo na apex proxy cíl.

Pokud result.status je active ale result.ssl.status není active, je hostitelský název aktivní, ale vydávání a nasazení jeho certifikátu ještě nebylo dokončeno. Úspěšný TLS handshake sám o sobě neznamená, že je zajištění certifikátu vlastního hostitelského názvu dokončeno, protože Cloudflare může pro daný hostitelský název prezentovat jiný odpovídající certifikát. Další informace najdete v Priorita certifikátu a hostitele.

Když použijete Create custom hostname endpoint, vyberte jeden ssl.method hodnota: http, txt, nebo email. U vlastních hostname bez zástupného znaku se Cloudflare vždy pokusí o Ověření certifikátu pomocí HTTP poté, co název hostitele začne směřovat na váš cíl SaaS, i když jste vybrali TXT ověření.

Záložní originy

Naše API obsahuje následující koncové body týkající se záložní origin vlastního hostitelského názvu: