← Dokumentace WAF / tools / lists / lists-api

Endpointy Lists API

K vyvolání Lists API operaci, připojte endpoint k základní URL Cloudflare API:

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

Pokyny k autentizaci najdete v části Cloudflare API Začínáme stránku.

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

Lists API podporuje níže uvedené operace. Příklady najdete pod souvisejícími odkazy.

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

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

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

• Operace: Aktualizace seznamu
• Metoda a endpoint: 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. K aktualizaci položky v seznamu použijte Aktualizace všech položek seznamu operace.

• Operace: Smazání seznamu
• Metoda a endpoint: DELETE accounts/{account_id}/rules/lists/{list_id}
• Poznámky: Smaže seznam, ale pouze pokud žádné filtry na něj odkazují.

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 mažete velké množství položek, může dokončení hromadné operace chvíli trvat.

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

Když odesíláte požadavky na seznam v době, kdy na něm probíhá hromadná operace, požadavky se zařadí do fronty a zpracují postupně (first in, first out). Požadavky úspěšných asynchronních operací vracejí HTTP 201 (stavový kód).

• Operace: Získání položek seznamu
• Metoda a endpoint: GET accounts/{account_id}/rules/lists/{list_id}/items[?search={query}]
• Poznámky:
  • Načte položky seznamu (ve výchozím nastavení všechny).
  • Položky jsou seřazeny vzestupně.
  • V případě IP seznamů se CIDR řadí podle IP adresy a poté podle masky podsítě.
  • K filtrování vrácených položek použijte volitelný search query string parametr. Více informací najdete v Získání položek seznamu operace API.

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

• Operace: Vytvoření položek seznamu
• Metoda a endpoint: POST accounts/{account_id}/rules/lists/{list_id}/items
• Poznámky:
  • Připojí novou položku nebo položky na konec seznamu.
  • Nahradí záznamy, které již v seznamu existují, žádné položky nemaže.
  • Přepíše comment původní položky.
  • Odpověď obsahuje operation_id.

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

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