Начало работы

Это руководство поможет проверить, что тегирование работает в вашем аккаунте, и выполнить первые вызовы API.

Предварительные требования

Как минимум один пользователь с ролью Super Administrator, Workers Admin или Tag Admin. Эти роли позволяют создавать, изменять и удалять теги.
API является предпочтительным способом управления тегами. Также можно использовать панель управления в разделе Manage Account > Маркировка ресурсов, но вам следует уверенно выполнять аутентифицированные HTTP-запросы для процессов автоматизации.
API токен с необходимыми правами. Account Owned Tokens рекомендуются для автоматизации.

1. Убедитесь, что теги включены

Проверьте API, чтобы убедиться, что тегирование активно для вашего аккаунта:

curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/keys" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json"

Интерпретация ответа

Ответ	Значение	Действие
200 OK с `{"success": true, "result": [...]}`	Тегирование включено. Пустой массив является нормальным ответом, если теги ещё не были заданы.	Перейдите к следующему шагу.
403 с упоминанием «permission» или «role»	У вызывающей стороны отсутствуют необходимые разрешения.	Убедитесь, что у вызывающей стороны есть роль Super Admin, Workers Admin или Tag Admin, либо что у токена есть `#com.cloudflare.api.account.tag.list` scope.
403 с упоминанием «feature» или «gate»	Тегирование не включено для этого аккаунта.	Обратитесь в Поддержка Cloudflare за помощью.
401 Unauthorized	Не удалось выполнить аутентификацию.	Убедитесь, что токен действителен, не истёк и правильно оформлен в `Authorization: Bearer` заголовок.
Любой другой ответ	Непредвиденная ошибка.	Сохраните полное тело ответа и обратитесь в Поддержка Cloudflare с идентификатором аккаунта, деталями запроса и меткой времени.

2. Создайте первые теги

Установка тегов для ресурса с помощью PUT:

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"
    }
  }'

Затем получите теги:

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" \
  -H "Content-Type: application/json"

3. Получите список помеченных ресурсов

Запросите все ресурсы с тегами в аккаунте, при необходимости отфильтровав по тегу:

# All tagged resources
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/resources" \
  -H "Authorization: Bearer $API_TOKEN"

# Filter: only resources with environment=production
curl -X GET "https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/tags/resources?tag=environment=production" \
  -H "Authorization: Bearer $API_TOKEN"

Следующие шаги

Ознакомьтесь с полным синтаксис фильтрации по тегам для сложных запросов.
Изучите Последовательность GET, объединение, PUT для изменения отдельных тегов.
Проверьте поддерживаемые типы ресурсов и их обязательные поля.
Проверьте Ограничения API и правила валидации.