Os endpoints desta página se aplicam apenas a aplicações website — apps com domínio web. Chamá-los em uma aplicação que não é web falha.
Domínio customizado
api.SetApplicationCustomDomain(appID, domain) define o domínio customizado vinculado ao site.
Registros DNS
Depois de vincular um domínio customizado, configure o DNS no seu registrador.api.GetApplicationDNS(appID) retorna os registros a criar como um []squarecloud.DNSRecord.
| Campo | Tipo | Descrição |
|---|---|---|
Type | string | "txt" ou "cname" — os registros TXT cobrem a propriedade do domínio e a validação SSL; o CNAME carrega o tráfego e sempre aponta para cname.squareweb.app |
Name | string | Nome do registro a criar |
Value | string | Valor do registro |
Status | string | Estado de validação: "pending", "pending_validation" ou "active" |
Analytics
api.GetApplicationAnalytics(appID, start, end) retorna analytics agregados da edge para a janela informada como um squarecloud.NetworkAnalytics. A janela é obrigatória, e a retenção máxima é de 7 dias.
Visits, Countries, Devices, OS, Browsers, Protocols, Methods, Paths, Referers, Providers) e buckets de janela inteira (IPs, StatusCodes, Bots, ContentTypes).
Para uma janela inteiramente anterior à criação da aplicação, a API retorna um objeto vazio — todos os slices da resposta são
nil. Verifique os tamanhos antes de indexar.Filtros de drill-down
Além da janela, o endpoint aceita filtros opcionais como query parameters — passe-os comrest.WithQueryParam. Cada filtro restringe todos os breakdowns da resposta de uma vez:
| Filtro | Notas |
|---|---|
country | Código de país com 2 letras, ex.: "BR" |
ip | Correspondência exata de IP |
path | Correspondência por prefixo, ex.: "/api" |
status | Código de status HTTP, ex.: "404" |
os | Sistema operacional |
browser | Nome do navegador |
protocol | Protocolo da requisição |
referer | Use "Direct" para requisições sem referer |
provider | Provedor de rede, ex.: "GOOGLE (15169)" (ASN) |
content_type | Use "Unknown" para tipos de conteúdo não classificados |
bot | Use "Unverified" para tráfego normal (não-bot) |
Monitoramento de erros
api.GetApplicationNetworkErrors(appID, start, end) retorna o breakdown de erros da edge. Por padrão, apenas erros 5xx são incluídos — adicione include_4xx=true para incluir os 4xx.
Logs por requisição
api.GetApplicationNetworkLogs(appID, start, end) retorna os logs por requisição da edge.
Logs por requisição exigem o plano Pro ou superior.
Percentis de latência
api.GetApplicationNetworkPerformance(appID, start, end) retorna as latências p50 / p95 / p99 para as camadas edge e origin.
Métricas de performance exigem o plano Pro ou superior.
Limpando o cache da edge
api.PurgeApplicationCache(appID) invalida o cache inteiro da edge para os domínios da aplicação.
Domínios e load balancers de toda a conta
Esses dois métodos operam sobre todas as aplicações da conta, não apenas um único site.Listando todos os domínios
api.GetApplicationDomains() retorna todos os domínios configurados em todas as aplicações da conta como um []squarecloud.AppDomain. Domínios customizados são listados primeiro; aplicações sem domínio web são omitidas.
Load balancers
api.GetLoadBalancers() agrupa aplicações que compartilham um domínio customizado, retornando um squarecloud.LoadBalancers.
Limit é o número máximo de aplicações que podem compartilhar um domínio no plano da conta: 2 (Standard), 5 (Pro), 10 (Enterprise).
