Pular para o conteúdo

Cloudflare

Cloudflare

O Cloudflare é uma rede global de segurança e desempenho que protege e acelera tudo que você conecta à Internet. Com a integração Cloudflare no SquadOS, seus agentes podem gerenciar registros DNS, zonas, listas WAF, regras de firewall, túneis, pools de balanceamento de carga e configurações de bot programaticamente, sem precisar acessar o painel web.

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

CampoObrigatórioDescrição
api_keySimToken de API do Cloudflare com as permissões necessárias para as operações desejadas.
  1. Acesse dash.cloudflare.com/profile/api-tokens — é a página de API Tokens do seu perfil.
  2. Clique em Create Token.
  3. Escolha um dos templates disponíveis ou clique em Create Custom Token para montar as permissões manualmente.
  4. Dê um nome descritivo ao token (ex.: SquadOS).
  5. Em Permissions, selecione os grupos e níveis de acesso que o token precisará (ex.: Zone → DNS → Edit para gerenciar registros DNS).
  6. Em Zone Resources, escolha as zonas às quais o token terá acesso (específicas ou todas).
  7. Opcionalmente, restrinja o token por IP de origem ou defina uma data de expiração (TTL).
  8. Clique em Continue to summary e, em seguida, em Create Token.
  9. Copie e guarde o token exibido — ele só é mostrado uma vez.
  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Cloudflare.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa o token de API obtido acima.
  5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

CLOUDFLARE_CREATE_DNS_RECORD

Cria um novo registro DNS em uma zona específica. Requer privilégios de escrita e aplica as alterações imediatamente na zona. Use após obter o ID da zona via CLOUDFLARE_LIST_ZONES para adicionar entradas DNS programaticamente.

NomeTipoObrigatórioDescrição
ttlintegerNãoTempo de vida em segundos; mínimo 1. Use 1 para TTL automático.
dataobjectNãoObjeto de dados adicionais para tipos de registro como SRV, LOC ou CAA.
namestringSimNome do registro DNS (ex.: example.com ou www.example.com).
tagsarrayNãoLista de tags a associar ao registro.
typestringSimTipo do registro DNS (A, AAAA, CNAME, MX, TXT, SRV, LOC, CAA).
commentstringNãoComentário legível para o registro DNS.
contentstringSimConteúdo do registro DNS (ex.: IP para registros A).
proxiedbooleanNãoSe o registro receberá os benefícios de desempenho e segurança do Cloudflare.
priorityintegerNãoPrioridade para registros MX, SRV e URI; obrigatório para esses tipos.
zone_identifierstringSimIdentificador da zona (UUID) onde o registro DNS será criado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_CREATE_LIST

Cria uma nova lista customizada vazia para uso em regras e filtros WAF. As listas podem conter endereços IP, hostnames, ASNs ou redirecionamentos. Após a criação, use ações separadas para adicionar itens à lista. Disponibilidade por plano: Free (1 lista), Pro/Business (10 listas), Enterprise (1000 listas).

NomeTipoObrigatórioDescrição
kindstringSimTipo da lista: ip, redirect, hostname ou asn.
namestringSimNome descritivo da lista (máx. 50 caracteres). Usado em expressões de filtro e regra.
account_idstringSimIdentificador da conta Cloudflare (máx. 32 caracteres).
descriptionstringNãoDescrição opcional da lista (máx. 500 caracteres).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_CREATE_ZONE

Cria uma nova zona DNS (domínio) no Cloudflare. Uma zona representa um domínio e seus registros DNS. Use ao adicionar um novo domínio para gerenciar pelo Cloudflare. Requer o ID da conta (obtível via CLOUDFLARE_LIST_ACCOUNTS). A zona ficará em status pending até que os nameservers sejam atualizados no registrador do domínio.

NomeTipoObrigatórioDescrição
namestringSimNome do domínio para a nova zona.
typestringNãoModo de configuração da zona: full (DNS hospedado pelo Cloudflare), partial (configuração CNAME) ou secondary (DNS secundário).
accountobjectNãoContainer para o ID da conta. Se não fornecido, a zona será criada na conta padrão das credenciais de API. Deve ser estruturado como {'id': '<account_id>'} onde id é obtido via CLOUDFLARE_LIST_ACCOUNTS.
jump_startbooleanNãoImportar automaticamente registros DNS existentes do domínio. Ignorado para zonas parciais.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_DELETE_DNS_RECORD

Exclui um registro DNS em uma zona específica. A exclusão é imediata e irreversível. Use somente após confirmar os IDs da zona e do registro. Requer privilégios de escrita na zona.

NomeTipoObrigatórioDescrição
identifierstringSimIdentificador do registro DNS a excluir (ex.: 372e67954025e0ba6aaa6d586b9e0b59).
zone_identifierstringSimIdentificador da zona DNS (ex.: 023e105f4ecef8ad9ca31a8372d0c353).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_DELETE_LIST

Exclui uma lista WAF. Use após verificar que nenhum filtro referencia a lista. Requer os identificadores da conta e da lista.

NomeTipoObrigatórioDescrição
list_idstringSimIdentificador único da lista WAF a excluir.
account_idstringSimIdentificador da conta Cloudflare.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_DELETE_ZONE

Exclui uma zona. Use após confirmar o identificador da zona para remover permanentemente uma zona DNS e todos os seus registros da conta Cloudflare.

NomeTipoObrigatórioDescrição
zone_identifierstringSimIdentificador da zona a excluir (string hexadecimal de 32 caracteres).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_GET_BOT_MANAGEMENT_SETTINGS

Recupera a configuração de Gerenciamento de Bots de uma zona (Bot Fight Mode / Super Bot Fight Mode / Enterprise Bot Management). Use após identificar o zone_id correto (ex.: via CLOUDFLARE_LIST_ZONES). Esta é a forma canônica de auditar configurações relacionadas a bots; regras de firewall são controles adjacentes, mas não equivalentes às configurações de Bot Management.

NomeTipoObrigatórioDescrição
zone_idstringSimIdentificador da zona (UUID) para recuperar as configurações de Bot Management. Obtido via ação Listar Zonas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_GET_LISTS

Busca todas as listas WAF (sem os itens) de uma conta. Os resultados são paginados; itere usando os parâmetros page e per_page até atingir result_info.total_pages para recuperar todas as listas.

NomeTipoObrigatórioDescrição
account_idstringSimIdentificador da conta Cloudflare (32 caracteres hexadecimais). Deve corresponder à conta proprietária da zona alvo para evitar mistura de dados entre contas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_LIST_ACCOUNT_MEMBERS

Lista todos os membros de uma conta Cloudflare com seus papéis, permissões e status. Retorna informações detalhadas sobre cada membro, incluindo dados do usuário (nome, e-mail, status de 2FA), papéis atribuídos com permissões granulares, status de adesão (aceito/pendente/rejeitado) e políticas de acesso. Suporta filtragem por status, ordenação por vários campos e paginação.

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página para paginação (deve ser >= 1). Padrão: 1.
orderstringNãoCampo para ordenar os resultados: user.first_name, user.last_name, user.email ou status.
statusstringNãoFiltrar membros por status: accepted (membros ativos), pending (convidados ainda não aceitos) ou rejected (convites recusados). Omitir para retornar todos.
per_pageintegerNãoNúmero de resultados por página (entre 5 e 50). Padrão da API: 20.
directionstringNãoDireção da ordenação: asc (crescente) ou desc (decrescente).
account_idstringSimIdentificador único (string hexadecimal de 32 caracteres) da conta Cloudflare cujos membros se deseja listar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_LIST_ACCOUNTS

Lista todas as contas Cloudflare às quais você tem acesso de proprietário ou verificado. Retorna uma lista paginada de contas com seus detalhes, incluindo ID, nome, tipo, configurações e data de criação. Um resultado vazio ou parcial pode indicar escopo insuficiente do token de API, não ausência de contas.

NomeTipoObrigatórioDescrição
namestringNãoFiltrar contas por nome. Pode retornar múltiplos resultados para nomes semelhantes; sempre verifique o account_id correto na resposta.
pageintegerNãoNúmero da página a recuperar, começando em 1.
per_pageintegerNãoNúmero de resultados por página (entre 5 e 50).
directionstringNãoDireção da ordenação dos resultados: asc ou desc.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_LIST_DNS_RECORDS

Lista e pesquisa registros DNS em uma zona Cloudflare. Use quando precisar encontrar IDs de registros DNS existentes para operações de atualização ou exclusão, especialmente após um erro “registro já existe” durante a criação.

NomeTipoObrigatórioDescrição
namestringNãoFiltrar pelo nome exato do registro DNS (FQDN).
pageintegerNãoNúmero da página para paginação, começando em 1.
typestringNãoFiltrar pelo tipo do registro DNS (A, AAAA, CAA, CERT, CNAME, DNSKEY, DS, HTTPS, LOC, MX, NAPTR, NS, PTR, SMIMEA, SRV, SSHFP, SVCB, TLSA, TXT, URI).
matchstringNãoLógica de correspondência dos filtros: all (AND) ou any (OR). Padrão: all.
contentstringNãoFiltrar pelo conteúdo/valor exato do registro DNS.
proxiedbooleanNãoFiltrar por status de proxy: true para registros com proxy, false para registros somente DNS.
zone_idstringSimIdentificador da zona (UUID) da qual listar os registros DNS.
per_pageintegerNãoNúmero de registros por página (1–5.000.000). Padrão: 100.
name_containsstringNãoFiltrar por nomes de registros DNS que contenham esta substring.
comment_containsstringNãoFiltrar por comentários que contenham esta substring.
content_containsstringNãoFiltrar por conteúdo do registro DNS que contenha esta substring.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_LIST_FIREWALL_RULES

Lista as regras de firewall de uma zona DNS específica. Use após confirmar o ID da zona para recuperar e auditar as regras de firewall atuais. Não expõe rotas do Workers nem outras construções de roteamento.

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página para resultados paginados, começando em 1. Verifique result_info.total_pages na resposta para determinar quando todas as páginas foram recuperadas.
matchstringNãoCritério de correspondência quando múltiplos filtros são fornecidos: all ou any.
orderstringNãoCampo para ordenar os resultados (ex.: priority, created_on).
zone_idstringSimUUID da zona para listar as regras de firewall.
per_pageintegerNãoNúmero de itens por página (1–1000).
directionstringNãoDireção da ordenação: asc ou desc.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_LIST_MONITORS

Lista todos os monitores de balanceamento de carga em uma conta Cloudflare. Use após criar ou atualizar monitores para recuperar uma lista paginada. A resposta inclui result_info.total_pages para determinar quando todas as páginas foram obtidas.

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página para resultados paginados (baseado em 1).
orderstringNãoCampo para ordenar (ex.: created_on, description).
per_pageintegerNãoNúmero de monitores por página (máx. 100).
directionstringNãoDireção da ordenação: asc ou desc.
account_idstringSimIdentificador da conta Cloudflare.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_LIST_POOLS

Lista todos os pools de balanceamento de carga em uma conta Cloudflare. Use após confirmar o ID da conta para descobrir os IDs dos pools. Pagine usando page e per_page; verifique result_info.total_pages na resposta para determinar se existem páginas adicionais.

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página para paginação (baseado em 1).
monitorstringNãoFiltrar pools por ID do monitor. Retorna apenas pools que usam este monitor de verificação de saúde específico.
per_pageintegerNãoNúmero de pools a retornar por página (1–50). Padrão: todos os pools.
account_idstringSimIdentificador da conta Cloudflare (UUID).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_LIST_TUNNELS

Lista os túneis Cloudflare Tunnel (cloudflared) em uma conta para descobrir IDs, nomes e status dos túneis. Use quando precisar encontrar um tunnel_id antes de realizar operações de túnel como roteamento, configuração DNS ou depuração.

NomeTipoObrigatórioDescrição
namestringNãoFiltrar túneis por nome.
pageintegerNãoNúmero da página para paginação, começando em 1.
per_pageintegerNãoNúmero de túneis por página.
account_idstringSimIdentificador da conta Cloudflare.
is_deletedbooleanNãoFiltrar por status de exclusão. true para incluir túneis excluídos, false para excluí-los.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_LIST_ZONES

Lista, pesquisa, ordena e filtra zonas na conta autenticada. Use page/per_page para paginar; verifique result_info.total_pages na resposta para iterar todas as páginas. Não retorna registros DNS — extraia o zone_id dos resultados antes de passá-lo para ferramentas com escopo de zona (DNS, firewall, etc.). Somente zonas delegadas aos nameservers do Cloudflare aparecem.

NomeTipoObrigatórioDescrição
namestringNãoNome de domínio. Operadores de filtro opcionais podem ser fornecidos para estender e refinar a busca.
pageintegerNãoNúmero da página dos resultados paginados.
matchstringNãoSe deve corresponder a todos os critérios de busca (all) ou a pelo menos um (any).
orderstringNãoCampo para ordenar as zonas: name, status, account.id, account.name ou plan.id.
statusstringNãoStatus da zona: initializing, pending, active ou moved.
accountobjectNãoFiltrar zonas por ID e/ou nome de conta.
per_pageintegerNãoNúmero de zonas por página.
directionstringNãoDireção da ordenação: asc ou desc.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_UPDATE_DNS_RECORD

Atualiza um registro DNS existente em uma zona específica. Use após confirmar os identificadores da zona e do registro; somente os campos fornecidos são modificados. Atualizações em registros usados por túneis ativos têm efeito imediato e podem interromper o tráfego em produção.

NomeTipoObrigatórioDescrição
ttlintegerNãoTempo de vida em segundos; use 1 para TTL automático.
dataobjectNãoDados adicionais específicos do registro para registros LOC, SRV e CAA.
namestringNãoNome do registro DNS (ex.: example.com).
typestringNãoTipo do registro DNS (A, AAAA, CNAME, CERT, DNSKEY, DS, LOC, MX, NS, PTR, SPF, SRV, SSHFP, TLSA, TXT, URI).
contentstringNãoConteúdo do registro DNS (ex.: endereço IP para registros A).
proxiedbooleanNãoSe o registro receberá os benefícios do Cloudflare.
priorityintegerNãoPrioridade para registros MX, SRV e URI; obrigatório para esses tipos.
identifierstringSimIdentificador do registro DNS (UUID) a atualizar.
zone_identifierstringSimIdentificador da zona (UUID) do registro DNS a atualizar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_UPDATE_LIST

Atualiza a descrição de uma lista WAF (não é possível atualizar os itens). Use após confirmar os metadados da lista.

NomeTipoObrigatórioDescrição
list_idstringSimIdentificador único da lista WAF.
account_idstringSimIdentificador da conta Cloudflare.
descriptionstringSimNova descrição para a lista WAF.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_UPDATE_TUNNEL_CONFIGURATION

Atualiza a configuração de um Cloudflare Tunnel gerenciado remotamente (regras de ingresso e roteamento). Use quando precisar configurar programaticamente mapeamentos hostname-para-origem para um túnel. ATENÇÃO: esta operação SUBSTITUI a configuração inteira — uma configuração incorreta pode quebrar o roteamento e tornar serviços inacessíveis. Boas práticas: busque a configuração atual primeiro (ao fazer patch) para preservar as regras existentes. Pelo menos uma regra de ingresso é obrigatória, e a última regra geralmente deve ser um catch-all (hostname='*' ou omitido) com service='http_status:404'.

NomeTipoObrigatórioDescrição
configobjectSimObjeto de configuração completo do túnel incluindo regras de ingresso. SUBSTITUI a configuração inteira — busque a configuração atual primeiro se precisar fazer patch em vez de substituição.
tunnel_idstringSimUUID do túnel a configurar.
account_idstringSimIdentificador da conta Cloudflare onde o túnel reside.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

CLOUDFLARE_UPDATE_ZONE

Atualiza propriedades de uma zona existente; as alterações se aplicam imediatamente à zona em produção. Confirme o ID da zona e a mudança pretendida antes de chamar. Apenas um campo pode ser modificado por chamada.

NomeTipoObrigatórioDescrição
typestringNãoTipo da zona: full, partial ou secondary. Apenas um de paused, type ou vanity_name_servers pode ser atualizado por chamada.
pausedbooleanNãoSe a zona deve ser pausada (true para pausar, false para retomar). Apenas um de paused, type ou vanity_name_servers pode ser atualizado por chamada.
zone_idstringSimIdentificador da zona (UUID).
vanity_name_serversarrayNãoNameservers customizados para modo vanity. Apenas um de paused, type ou vanity_name_servers pode ser atualizado por chamada.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.