Carregando Serverfy API Reference...
A API RESTful do Serverfy fornece uma interface de alta performance e isolamento seguro por Workspace para que você possa provisionar servidores cloud, gerenciar sites, configurar bancos de dados e interagir com webhooks de forma programática.
Provisionamento de servidores cloud na DigitalOcean, Hetzner, AWS, Linode e Vultr, acompanhamento de métricas de CPU e gerência de chaves SSH.
Criação de sites Laravel, Node.js ou estáticos, gerenciamento de certificados SSL automáticos (Let's Encrypt / On-Demand TLS) e deployments com zero-downtime.
Provisionamento de MySQL, PostgreSQL e Redis, gestão de usuários e criação de Instant DB Snapshots atômicos antes de cada migração.
Diagnóstico proativo de incidentes de infraestrutura, análise de causa-raiz e propostas de Correção Rápida supervisionada (Human-in-the-Loop).
Telemetria em tempo real, latência p50/p95/p99, agregação de exceções com rastreamento de erros, live logs e otimizador de Slow Queries.
Controle de servidores e deployments via linguagem natural diretamente pelo Claude Code, Cursor, Antigravity e IDEs modernas.
URL Base: https://serverfy.io/api/v1 Formato: application/json (UTF-8) Padrão: RESTful / JSON Payload
A API possui limite padrão de 100 requisições por minuto por Workspace. Todas as respostas contêm os cabeçalhos X-RateLimit-Limit e X-RateLimit-Remaining. Requisições que excederem o limite receberão o status HTTP 429 Too Many Requests.
| Código | Significado | Descrição |
|---|---|---|
200 OK |
Sucesso | A requisição foi processada e retornada com sucesso. |
201 Created |
Criado | O recurso (servidor, site, banco ou deploy) foi criado com sucesso. |
400 Bad Request |
Requisição Inválida | O corpo da requisição ou parâmetros enviados estão malformados. |
401 Unauthorized |
Não Autorizado | Chave de API (Bearer Token) ausente, inválida ou revogada. |
403 Forbidden |
Proibido | O Workspace não possui privilégios para executar a ação no recurso. |
404 Not Found |
Não Encontrado | O recurso solicitado não existe ou não pertence a este Workspace. |
422 Unprocessable |
Erro de Validação | Campos obrigatórios ausentes ou em desacordo com as regras. |
429 Rate Limit |
Limite Excedido | Limite de 100 requisições por minuto por Workspace atingido. |
500 Server Error |
Erro no Servidor | Falha interna de execução. Notifique nosso suporte ou verifique os logs. |
A API do Serverfy utiliza Bearer Tokens (Tokens de Acesso Pessoal) gerenciados pelo Laravel Sanctum, garantindo isolamento criptográfico por Workspace e controle estrito de permissões.
No painel lateral da aplicação, clique em Workspace > Chaves de API ou acesse diretamente pelo console.
Clique no botão "Nova Chave de API" no topo da listagem de chaves.
Atribua um nome claro que descreva o propósito da integração (ex: CI/CD Deployments, MCP Agent Local, Backup Sync).
Copie o token imediatamente. Por motivos de segurança, o token completo só é exibido uma única vez no momento da criação.
Authorization: Bearer 1|abcdef1234567890abcdef1234567890 Accept: application/json Content-Type: application/json
curl -X GET "https://serverfy.io/api/v1/servers" \ -H "Authorization: Bearer SEU_TOKEN_AQUI" \ -H "Accept: application/json"
Caso a chave esteja ausente, incorreta ou revogada, a API responderá com status HTTP 401:
{ "message": "Unauthenticated." }
O Serverfy suporta nativamente o Model Context Protocol (MCP), permitindo conectar assistentes de Inteligência Artificial modernos — como Claude Code, Claude Desktop, Cursor e Antigravity — diretamente à infraestrutura do seu Workspace.
Ao habilitar a conexão MCP, a IA ganha habilidades estritas (Tools) para inspecionar métricas, disparar deployments com rollback atômico e reiniciar serviços de forma segura, auditável e protegida.
No painel do Serverfy, gere um Personal Access Token com as permissões adequadas.
O token gerado será o seu Bearer Token para autenticação com o servidor SSE do MCP.
Configure o cliente repassando o cabeçalho AUTHORIZATION: Bearer SEU_TOKEN nas variáveis de ambiente.
To connect Serverfy to Anthropic's Claude, open the configuration file ~/Library/Application Support/Claude/claude_desktop_config.json (Mac) Ou %APPDATA%\Claude\claude_desktop_config.json (Windows) e adicione o servidor via SSE:
{ "mcpServers": { "serverfy": { "command": "npx", "args": [ "-y", "@modelcontextprotocol/server-sse", "https://serverfy.io/api/v1/mcp/sse" ], "env": { "AUTHORIZATION": "Bearer SEU_TOKEN_AQUI" } } } }
O servidor MCP do Serverfy expõe um catálogo completo de ferramentas granulares, seguras e auditadas para copilotos de IA.
list_serversLista servidores provisionados, provedores cloud (AWS, DO, Hetzner, Vultr) e status de conectividade.
list_sitesLista aplicações, domínios, branches ativas, runtime e status atual de cada site do workspace.
deploy_siteDispara deployment atômico com zero-downtime, verificação de integridade e rollback automático em caso de falha.
read_server_metricsObtém telemetria em tempo real de CPU, memória RAM, uso de disco e séries temporais históricas de 1h a 7 dias.
restart_workerReinicia workers de background (Supervisor/Horizon) com encerramento gracioso das filas ativas.
promote_staging_sitePromove ambiente de homologação ou preview efêmero de PR para produção com sincronização de banco.
manage_site_cacheConfigura regras de micro-caching FastCGI/Caddy, TTL, bypass para sessões autenticadas e headers HTTP.
purge_fastcgi_cachePurga instantaneamente o cache em memória e disco de uma aplicação sem reiniciar o servidor web.
manage_site_hibernationHiberna sites inativos ou restaura aplicações sob demanda com proxy de retenção, liberando memória e CPU.
manage_telemetryConfigura retenção de logs, métricas do Sentinel Sense e alertas de latência percentil (p95/p99).
manage_load_balancerGerencia pools de upstream multi-nó, políticas de balanceamento (round-robin, least-conn) e health checks.
list_database_replicasConsulta réplicas de leitura configuradas para MySQL/PostgreSQL e latência de replicação (seconds behind master).
create_database_replicaProvisiona e sincroniza nova réplica de banco com streaming replication em nós secundários.
promote_database_replicaPromove réplica secundária a nó primário em caso de manutenção ou failover.
manage_backup_replicationConfigura replicação cruzada de backups entre múltiplos provedores S3, Backblaze B2 e Wasabi.
evaluate_dns_failoverVerifica saúde das zonas Cloudflare/Route53 e executa comutação automática de tráfego de nós degradados.
list_centurion_proposalsLista propostas autônomas de otimização de servidor geradas pelo Centurion AI Copilot pendentes de aprovação.
approve_centurion_proposalAprova e executa plano de ação recomendado pela IA com rastreamento completo de auditoria.
reject_centurion_proposalDescarta proposta de ação com justificativa técnica registrada para aprendizado do copiloto.
run_centurion_watchdogDispara varredura sob demanda de processos zumbis, travamentos de porta e sobrecarga de CPU.
run_compliance_scanExecuta auditoria CIS Benchmark e validação de permissões SSH, firewall UFW e versões do runtime.
remediate_compliance_issueAplica correção automática para falhas de conformidade identificadas no relatório de segurança.
Com o MCP configurado no Claude ou Cursor, você pode pedir coisas como: "Faça o deploy do site de homologação no servidor web-01" Ou "Analise os logs de erro do Nginx nos últimos 15 minutos e me diga qual endpoint está falhando".
Observabilidade unificada e auto-cura para servidores e aplicações: telemetria de latência p50/p95/p99, rastreamento inteligente de exceções, live logs unificados, detecção antecipada de incidentes e otimização automatizada de Slow Queries.
Diagnóstico contínuo de anomalias (OOM Killers, loops de crash, alta concorrência de PHP-FPM) e sugestão de Correções Rápidas (Quick Fixes) acionáveis com aprovação humana.
Histogramas e percentis de latência HTTP (p50, p95 e p99), taxa de throughput (req/seg) e status codes agrupados em tempo real sem sobrecarga.
Monitoramento de consultas SQL lentas (>100ms) e detecção de consultas N+1, fornecendo o EXPLAIN estruturado e scripts prontos de criação de índices.
Captura e agregação automática de erros e exceções não tratadas com stack trace completo, variáveis de ambiente sanitizadas e histórico de ocorrências.
O agente do Serverfy coleta métricas do sistema e das aplicações e as envia periodicamente. Você também pode integrar sistemas customizados através dos endpoints autenticados da API:
curl -X POST "https://serverfy.io/api/v1/telemetry/ingest" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "server_id": "srv-01", "metrics": { "cpu_usage": 23.4, "memory_used_mb": 1840, "http_p95_ms": 112 } }'
O Sentinel AI nunca aplica alterações estruturais ou destrutivas sem autorização explícita. Ao detectar um incidente, ele formula a causa-raiz e disponibiliza a ação de Remediação Assistida para que você execute com apenas um clique.
Blindagem completa para sua infraestrutura contra perdas de dados e indisponibilidade: Instant DB Snapshots automáticos antes de cada deploy com rollback instantâneo, replicação cross-cloud em múltiplos provedores de storage e autoscaling inteligente de workers.
Criação de ponto de restauração instantâneo do banco de dados antes da execução de migrations. Se a release falhar, reverta para o estado exato com 1 clique.
Distribuição simultânea de backups entre múltiplos provedores independentes (AWS S3, Cloudflare R2 e DigitalOcean Spaces) eliminando vendor lock-in.
Ajuste dinâmico de instâncias de filas Supervisor e workers PHP/Redis baseado na latência da fila e número de jobs pendentes em tempo real.
Emissão dinâmica e automática de certificados SSL para domínios customizados de clientes de plataformas SaaS, com verificação de segurança Ask URL.
curl -X POST "https://serverfy.io/api/v1/databases/db-prod-01/snapshots" \ -H "Authorization: Bearer SEU_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "pre-migration-v2.5", "replicate_cross_cloud": true }'
Native integration with cloud DNS providers to automate domain validation, root A records, CAA issuance records for Let's Encrypt SSL, and wildcard routing across all provisioned servers.
Automated record provisioning using dedicated IAM access keys with granular zone-level permissions.
Scoped API tokens restricted to Zone:DNS edit capabilities for enterprise and personal domains.
Direct domain synchronization using DigitalOcean Personal Access Tokens with write privilege.
For security, never use AWS root account keys. Create a dedicated IAM user with specific Route 53 permissions.
Navigate to IAM > Users > Create User. Set username as serverfy-route53 and select Attach policies directly.
Attach the AmazonRoute53FullAccess policy or apply the least-privilege JSON policy shown below.
Under Security Credentials, click Create Access Key. Select Third-party service and copy Access Key ID and Secret Access Key.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "route53:ListHostedZones", "route53:GetHostedZone", "route53:ListResourceRecordSets", "route53:ChangeResourceRecordSets", "route53:GetChange" ], "Resource": "*" } ] }
In Cloudflare, always use a scoped API Token with Zone:DNS Edit and Zone:Zone Settings Edit permissions instead of the Global API Key.
Open dash.cloudflare.com/profile/api-tokens and click Create Token.
Grant Zone > DNS > Edit (to manage A, CAA records & enable orange cloud proxy) and Zone > Zone Settings > Edit (to automate Full Strict SSL and Always Use HTTPS without redirect loops).
Save the generated token and paste it into Workspace > DNS Providers > Cloudflare.
Generate a Personal Access Token in DigitalOcean with Read and Write permissions to enable full DNS zone management.
Go to cloud.digitalocean.com/account/api/tokens and click Generate New Token.
Set token name (e.g. serverfy-dns) and ensure Write scope is enabled.