← Dokumentace WAF / tools / lists / lists-api

Endpointy Lists API

Chcete-li vyvolat Lists API operaci a k základní URL rozhraní Cloudflare API připojte koncový bod:

https://api.cloudflare.com/client/v4/

Pokyny k ověřování najdete v rozhraní Cloudflare API, konkrétně v Začínáme stránce.

Nápovědu k volání API a stránkování výsledků najdete v Volání API.

Lists API podporuje níže uvedené operace. Příklady najdete v souvisejících odkazech.

• Operace: Vytvořte seznam
• Metoda a koncový bod: POST accounts/{account_id}/rules/lists
• Poznámky: Vytvoří prázdný seznam.

• Operace: Získání seznamů
• Metoda a koncový bod: GET accounts/{account_id}/rules/lists
• Poznámky:
  • Načte všechny seznamy pro účet.
  • Tento požadavek nenačítá položky seznamů.

• Operace: Získání seznamu
• Metoda a koncový bod: GET accounts/{account_id}/rules/lists/{list_id}
• Poznámky:
  • Načte seznam podle jeho ID.
  • Tento požadavek nezobrazuje položky seznamu.

• Operace: Aktualizace seznamu
• Metoda a koncový bod: PUT accounts/{account_id}/rules/lists/{list_id}
• Poznámky:
  • Aktualizuje description seznamu.
  • Nelze upravit name nebo kind, a položky v seznamu nelze aktualizovat. Chcete-li aktualizovat položku v seznamu, použijte Aktualizace všech položek seznamu operace.

• Operace: Odstranění seznamu
• Metoda a koncový bod: DELETE accounts/{account_id}/rules/lists/{list_id}
• Poznámky: Odstraní seznam, ale pouze pokud na něj neodkazuje žádné filtry na ni odkazovat.

Téměř všechny operace pro správu položek v seznamu jsou asynchronní. Když do seznamu přidáváte nebo z něj odebíráte velké množství položek, může před dokončením hromadné operace dojít ke zpoždění.

Asynchronní operace se seznamy vracejí operation_id, pomocí kterého můžete sledovat stav operace API. Ke sledování stavu asynchronní operace použijte Získat stav hromadné operace endpoint a zadejte ID operace, kterou chcete sledovat.

Když odešlete požadavky na seznam ve chvíli, kdy nad ním právě probíhá hromadná operace, tyto požadavky se zařadí do fronty a zpracují postupně v pořadí, v jakém přišly (first in, first out). Požadavky na úspěšné asynchronní operace vracejí HTTP 201 stavový kód.

• Operace: Získání položek seznamu
• Metoda a koncový bod: GET accounts/{account_id}/rules/lists/{list_id}/items[?search={query}]
• Poznámky:
  • Načte položky v seznamu (ve výchozím nastavení všechny položky).
  • Položky jsou seřazeny vzestupně.
  • V případě seznamů IP adres se rozsahy CIDR řadí podle IP adresy a poté podle masky podsítě.
  • Chcete-li filtrovat vrácené položky, použijte volitelný search parametr řetězce dotazu. Další informace najdete v Získání položek seznamu operace API.

• Operace: Získání položky seznamu
• Metoda a koncový bod: GET accounts/{account_id}/rules/lists/{list_id}/items/{item_id}
• Poznámky: Načte položku ze seznamu podle ID

• Operace: Vytvořte položky seznamu
• Metoda a koncový bod: POST accounts/{account_id}/rules/lists/{list_id}/items
• Poznámky:
  • Přidá do seznamu novou položku nebo položky.
  • Nahradí položky, které v seznamu již existují, žádné položky neodstraní.
  • Přepíše comment původní položky.
  • Odpověď obsahuje operation_id.

• Operace: Aktualizace všech položek seznamu
• Metoda a koncový bod: PUT accounts/{account_id}/rules/lists/{list_id}/items
• Poznámky:
  • Odstraní všechny aktuální položky seznamu a nahradí je items.
  • Když items je prázdné, odstraní all položek v seznamu.
  • Odpověď obsahuje operation_id.

• Operace: Odstranění položek seznamu
• Metoda a koncový bod: DELETE accounts/{account_id}/rules/lists/{list_id}/items
• Poznámky:
  • Odstraní zadané položky seznamu.
  • Odpověď obsahuje operation_id.