INTEGRITY Dokumentace

Správa štítků

Všechny operace s tagy používají Tagging API. Ověření vyžaduje API token účtu nebo uživatelský API token s příslušnými oprávněními.

Nastavit tagy na zdroji

Použijte PUT k nastavení tagů u prostředku na úrovni účtu. Tato operace nahradí všechny stávající tagy prostředku.

curl -X PUT "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "resource_type": "worker",
    "resource_id": "'"$RESOURCE_ID"'",
    "tags": {
      "environment": "production",
      "team": "platform",
      "cost-center": "engineering"
    }
  }'

U prostředků na úrovni zóny použijte endpoint zóny:

curl -X PUT "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/tags" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "resource_type": "zone",
    "resource_id": "'"$ZONE_ID"'",
    "tags": {
      "environment": "production",
      "customer": "acme-corp"
    }
  }'

Některé typy zdrojů vyžadují další pole. Viz podporované typy prostředků s podrobnostmi.

Získání štítků prostředku

Načtěte tagy pro konkrétní zdroj:

curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags?resource_type=worker&resource_id=$RESOURCE_ID" \
  -H "Authorization: Bearer $API_TOKEN"

Přidání jednoho tagu

API nepodporuje částečné aktualizace: PUT vždy nahradí všechny tagy. Pokud chcete přidat tag bez odstranění stávajících, použijte GET, sloučit, PUT vzor:

  1. GET aktuální tagy.
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags?resource_type=worker&resource_id=$RESOURCE_ID" \
  -H "Authorization: Bearer $API_TOKEN"

# Response: {"result": {"tags": {"environment": "production", "team": "platform"}}}
  1. Nový štítek sloučte lokálně se stávající sadou.
{
  "environment": "production",
  "team": "platform",
  "cost-center": "engineering"
}
  1. PUT úplnou sloučenou sadu tagů.
curl -X PUT "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "resource_type": "worker",
    "resource_id": "'"$RESOURCE_ID"'",
    "tags": {
      "environment": "production",
      "team": "platform",
      "cost-center": "engineering"
    }
  }'

Odebrat jeden tag

Postupujte stejně jako GET, sloučit, PUT vzor, ale ze sady vynechte tag, který chcete odstranit, před voláním PUT.

Odstranění všech štítků

Chcete-li odebrat všechny tagy ze zdroje:

curl -X DELETE "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "resource_type": "worker",
    "resource_id": "'"$RESOURCE_ID"'"
  }'

Toto vrátí 204 No Content při úspěchu. Použijte pouze DELETE když chcete z prostředku odstranit všechny tagy (například při jeho vyřazování z provozu).