Hostinger
oficialImplante e gerencie seus sites diretamente do seu IDE conectando sua conta Hostinger. Gerencie sites, domínios, DNS, VPS, e-commerce, e-mail marketing e faturamento em um só lugar.
O que você pode fazer com Hostinger MCP?
- Implantar sites a partir de arquivos — Peça para implantar um site Node.js estático ou PHP a partir de um arquivo, com upload automático de arquivos e build.
- Gerenciar domínios e SSL — Vincular/desvincular domínios, alterar o domínio principal e instalar, reinstalar ou remover certificados SSL Let's Encrypt.
- Configurar PHP e WordPress — Alternar versões do PHP, habilitar extensões, definir opções do php.ini ou alterar versões e configurações do núcleo do WordPress.
- Provisionar e monitorar sites — Criar novos sites do Agency Plan, verificar o status da configuração, listar sites e visualizar métricas de uso de recursos ou disco.
- Gerenciar bancos de dados e tarefas agendadas — Criar, listar ou excluir bancos de dados/usuários MySQL e agendar ou remover tarefas agendadas (cron jobs) para um site.
- Executar verificações de prontidão do agente — Iniciar e obter pontuações de prontidão de agentes de IA para sites públicos, a fim de avaliar a capacidade de descoberta.
Documentação
hostinger-api-mcp
Servidor Model Context Protocol (MCP) para a API da Hostinger.
Início rápido: servidor remoto hospedado
Se você não quiser instalar ou executar nada localmente, conecte-se diretamente ao servidor MCP hospedado da Hostinger:
https://mcp.hostinger.com
Claude Code
claude mcp add --transport http hostinger https://mcp.hostinger.com
Isso abre uma janela do navegador para autorizar via OAuth. Após a aprovação, as operações abaixo ficam acessíveis por meio de execute na sua sessão.
Outros clientes compatíveis com MCP
Adicione https://mcp.hostinger.com como um servidor MCP HTTP Streamable remoto na configuração do seu cliente e conclua o prompt de OAuth quando ele aparecer. Consulte a documentação do seu cliente para saber como expor as configurações de "adicionar servidor MCP remoto" / "conector personalizado".
Pré-requisitos
- Node.js versão 24 ou superior
Se você não tiver o Node.js instalado, pode baixá-lo no site oficial. Alternativamente, você pode usar um gerenciador de pacotes como Homebrew (para macOS) ou Chocolatey (para Windows) para instalar o Node.js.
Recomendamos usar o NVM (Node Version Manager) para instalar e gerenciar as versões instaladas do Node.js. Após instalar o NVM, você pode instalar o Node.js com o seguinte comando:
nvm install v24
nvm use v24
Instalação
Para instalar o servidor MCP, execute um dos seguintes comandos, dependendo do seu gerenciador de pacotes:
# Install globally from npm
npm install -g @hostinger/mcp
# Or with yarn
yarn global add @hostinger/mcp
# Or with pnpm
pnpm add -g @hostinger/mcp
Atualização
Para atualizar o servidor MCP para a versão mais recente, use um dos seguintes comandos, dependendo do seu gerenciador de pacotes:
# Update globally from npm
npm update -g @hostinger/mcp
# Or with yarn
yarn global upgrade @hostinger/mcp
# Or with pnpm
pnpm update -g @hostinger/mcp
Binários
Este pacote instala os seguintes comandos do servidor MCP:
hostinger-api-mcp— servidor unificado sobre todas as operações (421 no total)hostinger-agency-hosting-mcp— 42 operações para agency-hostinghostinger-agent-readiness-mcp— 3 operações para agent-readinesshostinger-billing-mcp— 9 operações para billinghostinger-dns-mcp— 8 operações para dnshostinger-domains-mcp— 42 operações para domainshostinger-ecommerce-mcp— 29 operações para ecommercehostinger-horizons-mcp— 6 operações para horizonshostinger-hosting-mcp— 81 operações para hostinghostinger-mail-mcp— 38 operações para mailhostinger-reach-mcp— 56 operações para reachhostinger-vps-mcp— 67 operações para vpshostinger-wordpress-mcp— 40 operações para wordpress
Cada binário expõe as mesmas três ferramentas; um binário com escopo definido apenas pesquisa e executa as operações do seu próprio grupo. hostinger-api-mcp permanece como o padrão compatível com versões anteriores.
Configuração
As seguintes variáveis de ambiente podem ser configuradas ao executar o servidor:
DEBUG: Ativar registro de depuração (true/false) (padrão: false)HOSTINGER_API_TOKEN: Seu token de API, que será enviado no cabeçalhoAuthorization. Quando definido, o OAuth é totalmente ignorado.API_TOKEN: Alias obsoleto paraHOSTINGER_API_TOKEN. Será removido em uma versão futura — prefiraHOSTINGER_API_TOKEN.OAUTH_ISSUER: URL base do servidor OAuth (padrão:https://auth.hostinger.com). Usado apenas quandoHOSTINGER_API_TOKENnão está definido.
Autenticação
O servidor suporta dois métodos de autenticação:
Token de API (recomendado para CI/scripts)
Defina HOSTINGER_API_TOKEN no ambiente ou no arquivo .env. Quando presente, ele sempre tem precedência — nenhum código OAuth é executado.
OAuth 2.0 com PKCE (login interativo)
Quando HOSTINGER_API_TOKEN não está definido e o servidor roda em modo stdio, o OAuth 2.0 com PKCE é usado automaticamente na primeira chamada de ferramenta autenticada:
- Um cliente OAuth dinâmico é registrado com o emissor (RFC 7591) — uma vez por máquina.
- Uma janela do navegador abre na página de autorização.
- Após o login, o servidor captura o redirecionamento em uma porta local efêmera, troca o código por tokens e os armazena.
- Chamadas subsequentes reutilizam o token de acesso armazenado; tokens expirados são renovados automaticamente. Se um token de atualização for revogado, o fluxo do navegador é relançado.
As credenciais são armazenadas em:
- macOS / Linux:
~/.config/hostinger-mcp/credentials.json(modo 0600) - Windows:
%APPDATA%\hostinger-mcp\credentials.json
As credenciais são compartilhadas entre todos os binários MCP da Hostinger (hostinger-api-mcp, hostinger-vps-mcp, etc.).
Comandos manuais:
# Run the OAuth sign-in flow immediately (don't wait for the first tool call)
hostinger-api-mcp --login
# Revoke stored credentials
hostinger-api-mcp --logout
Nota sobre transporte HTTP: O login OAuth não é suportado no modo --http. Defina HOSTINGER_API_TOKEN antes de usar --http.
Uso
Configuração JSON para Claude, Cursor, etc.
{
"mcpServers": {
"hostinger-api": {
"command": "hostinger-api-mcp",
"env": {
"DEBUG": "false",
"HOSTINGER_API_TOKEN": "YOUR API TOKEN"
}
}
}
}
Opções de Transporte
O servidor MCP suporta dois modos de transporte:
Transporte de I/O Padrão
O servidor pode usar transporte de entrada/saída padrão (stdio) (padrão). Isso fornece streaming local:
Transporte HTTP Streamable
O servidor pode usar transporte de streaming HTTP. Isso fornece streaming bidirecional sobre HTTP:
# Default HTTP transport on localhost:8100
hostinger-api-mcp --http
# Specify custom host and port
hostinger-api-mcp --http --host 0.0.0.0 --port 8150
Opções de Linha de Comando
Options:
--http Use HTTP streaming transport (requires HOSTINGER_API_TOKEN env var)
--stdio Use Server-Sent Events transport (default)
--host {host} Hostname or IP address to listen on (default: 127.0.0.1)
--port {port} Port to bind to (default: 8100)
--login Run OAuth sign-in flow and exit
--logout Revoke stored OAuth credentials and exit
--help Show help message
Uso como Provedor de Ferramentas MCP
Este servidor implementa o Model Context Protocol (MCP) e pode ser usado com qualquer consumidor compatível com MCP.
Exemplo de conexão a este servidor usando transporte de streaming HTTP:
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
// Create HTTP transport
const transport = new StreamableHTTPClientTransport({
url: "http://localhost:8100/",
headers: {
"Authorization": `Bearer ${process.env.HOSTINGER_API_TOKEN}`
}
});
// Connect to the MCP server
const client = new Client({
name: "my-client",
version: "1.0.0"
}, {
capabilities: {}
});
await client.connect(transport);
// List available tools
const { tools } = await client.listTools();
console.log("Available tools:", tools);
// Execute an operation
const result = await client.callTool({
name: "execute",
arguments: { operation: "billing_catalog_list", params: { category: "DOMAIN" } }
});
console.log("Tool result:", result);
Ferramentas
Cada servidor expõe três ferramentas:
search— encontra operações por palavra-chave; retorna cada correspondência com seuinputSchema.execute— executa uma operação:{ "operation": "<name>", "params": { ... } }.multi-execute— executa até 20 operações em ordem, parando na primeira falha. Um valor de params que seja exatamente"$steps.<i>.<path>"é substituído por esse valor do resultado de uma etapa anterior.
Operações
As operações acessíveis por meio de execute, por binário:
hostinger-agency-hosting-mcp
agency-hosting_deploy-node-static-website
Implanta um site do Plano Agency node-static (h5g) a partir de um arquivo compactado. AVISO: isso sobrescreve o conteúdo existente do site e não pode ser desfeito — sempre confirme com o usuário antes de prosseguir. Use isso para sites do Plano Agency do tipo node-static (um site estático construído com Node.js que requer uma etapa de build ou um site estático simples). A ferramenta resolve o site a partir do seu domínio, envia o arquivo compactado para o gerenciador de arquivos do site via TUS e aciona o processo build-assets que constrói o site e implanta o resultado em public_html. Esta operação é síncrona: o build e a implantação são concluídos antes de a ferramenta retornar, então o site fica no ar assim que a ferramenta termina com sucesso — não há build assíncrono separado para aguardar ou consultar. As credenciais de upload são geradas e usadas internamente — não chame um endpoint separado de upload-url nem envie o arquivo compactado você mesmo, esta ferramenta faz tudo de ponta a ponta. Para aplicações PHP simples que devem ser extraídas como estão, use agency-hosting_deploy-php-application. O UID do site é resolvido automaticamente a partir do domínio.
- Método:
custom - Caminho:
custom
agency-hosting_deploy-php-application
Implanta um site do Plano Agency (h5g) PHP (ou outro sem build) a partir de um arquivo compactado. AVISO: isso sobrescreve o conteúdo existente do site e não pode ser desfeito — sempre confirme com o usuário antes de prosseguir. Use isso para sites do Plano Agency onde o conteúdo do arquivo compactado deve ser extraído e servido como está, sem etapa de build (por exemplo, aplicações PHP). A ferramenta resolve o site a partir do seu domínio, envia o arquivo compactado para o gerenciador de arquivos do site via TUS e aciona o processo import-archive que sobrescreve o conteúdo do site com o conteúdo do arquivo compactado. Esta operação é síncrona: o arquivo compactado é extraído e implantado antes de a ferramenta retornar, então o site fica no ar assim que a ferramenta termina com sucesso — não há build assíncrono separado para aguardar ou consultar. As credenciais de upload são geradas e usadas internamente — não chame um endpoint separado de upload-url nem envie o arquivo compactado você mesmo, esta ferramenta faz tudo de ponta a ponta. Para sites node-static que requerem uma etapa de build, use agency-hosting_deploy-node-static-website. O UID do site é resolvido automaticamente a partir do domínio.
- Método:
custom - Caminho:
custom
agency-hosting_datacenters_list
Lista os datacenters disponíveis para provisionar um novo site no pedido de hospedagem do Plano Agency fornecido.
Cada datacenter inclui um pinger_url que você pode testar com ping a partir do cliente para medir a latência de ida e volta; comparar os resultados entre datacenters permite escolher o mais próximo (menor ping) antes de selecionar seu code como o datacenter_code ao criar uma configuração de site.
- Método:
GET - Caminho:
/api/agency-hosting/v1/orders/{order_id}/datacenters
agency-hosting_domains_change-website
Altera o domínio principal de um site do Plano Agency.
Forneça o domínio atual no caminho e o novo domínio no corpo da solicitação. Defina domain como null para reverter ao domínio temporário.
- Método:
PUT - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/domains/{from_domain}
agency-hosting_domains_link-to-website
Vincula um domínio ao site do Plano Agency especificado para que ele possa servir tráfego para esse domínio.
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/domains
agency-hosting_domains_list
Retorna uma lista paginada de domínios associados a sites do Plano Agency acessíveis ao cliente autenticado.
Use o filtro website_uuids para restringir os resultados a sites específicos.
- Método:
GET - Caminho:
/api/agency-hosting/v1/domains
agency-hosting_domains_unlink-from-website
Desvincula um domínio do site do Plano Agency especificado.
O site para de servir tráfego neste domínio imediatamente.
Os arquivos do site e o banco de dados são preservados, e quaisquer outros domínios vinculados permanecem acessíveis.
Se este for o único domínio no site, desvincular deixa o site sem um domínio acessível.
- Método:
DELETE - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}
agency-hosting_files_generate-upload-url
Gera uma URL de upload do gerenciador de arquivos com credenciais de autenticação para enviar arquivos ao armazenamento de arquivos de um site do Plano Agency.
Retorna url, auth_key e rest_auth_key. Use-os para enviar um arquivo ao armazenamento de arquivos do site via protocolo de upload retomável TUS (TUS 1.0.0). Envie os cabeçalhos X-Auth: {auth_key} e X-Auth-Rest: {rest_auth_key} em cada solicitação abaixo.
- Crie o upload:
POSTpara{url}/{relative_file_path}?override=truecom os cabeçalhosupload-length: {file size in bytes}eupload-offset: 0. Espere201 Created. - Envie o arquivo: envie os bytes do arquivo para o mesmo local (qualquer cliente TUS 1.0.0, ou solicitações
PATCHcom um cabeçalhoupload-offsetrastreando o progresso) até a conclusão.
relative_file_path é o caminho de destino dentro do armazenamento de arquivos do site, por exemplo, app.zip.
Em vez de um cliente TUS, curl simples também funciona:
FILE=app.zip
SIZE=$(stat -f%z "$FILE") # stat -c%s on Linux
curl -i -X POST "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Upload-Length: ${SIZE}" \
-H "Upload-Offset: 0"
# -> 201 Created
curl -i -X PATCH "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Content-Type: application/offset+octet-stream" \
-H "Upload-Offset: 0" \
--data-binary "@${FILE}"
# -> 204 No Content, Upload-Offset response header equals SIZE when done
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/files/upload-urls
agency-hosting_files_import-website-from-archive
Importa um site do Plano Agency a partir de um arquivo compactado já enviado.
Envie o arquivo compactado para o diretório raiz do site via gerenciador de arquivos primeiro e, em seguida, forneça o nome do arquivo nesta solicitação. O conteúdo do site é sobrescrito pelo conteúdo do arquivo compactado. Tipos de arquivo compactado suportados: .zip, .tar, .tar.gz, .tgz.
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/files/import-archive
agency-hosting_metrics_list-plan-order-disk-usage
Retorna o uso agregado de disco e inodes para o pedido do Plano Agency no período selecionado, além das cotas do plano. Os números cobrem toda a conta do pedido. Os valores podem estar desatualizados em até uma hora. O uso de CPU, memória e processos está no endpoint resource-usage-metrics.
- Método:
GET - Caminho:
/api/agency-hosting/v1/orders/{order_id}/disk-usage-metrics
agency-hosting_orders_list
Retorna uma lista paginada de pedidos do Plano Agency acessíveis ao cliente autenticado.
- Método:
GET - Caminho:
/api/agency-hosting/v1/orders
agency-hosting_metrics_list-order-resource-usage
Retorna o uso agregado de CPU, memória e processos para o pedido do Plano Agency no período selecionado, além das cotas do plano e um detalhamento por site. Cada site é identificado por uid. Sites suspensos e excluídos são excluídos tanto dos totais do pedido quanto do detalhamento por site. Os valores podem estar desatualizados em até uma hora. O uso de disco e inodes está no endpoint disk-usage-metrics.
- Método:
GET - Caminho:
/api/agency-hosting/v1/orders/{order_id}/resource-usage-metrics
agency-hosting_php_list-extensions-for-website
Lista todas as extensões PHP disponíveis para um site do Plano Agency e se estão atualmente habilitadas.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions
agency-hosting_php_replace-website-extensions
Substitui o conjunto de extensões PHP habilitadas em um site do Plano Agency pelas fornecidas. Qualquer extensão alternável que não esteja na solicitação é desabilitada, então chame primeiro o endpoint de extensões e envie o conjunto completo desejado. Extensões compiladas no PHP, reportadas com o estado "built-in", estão sempre ativas e não são afetadas.
- Método:
PUT - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions
agency-hosting_php_list-options-for-website
Lista as diretivas do php.ini que podem ser configuradas para um site do Plano Agency, cada uma com seu valor padrão, o valor atualmente em vigor e os valores que aceita.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/options
agency-hosting_php_replace-website-options
Substitui os valores personalizados do php.ini em um site do Plano Agency pelos fornecidos. Qualquer opção que não esteja na solicitação é redefinida para o padrão, então chame primeiro o endpoint de opções e envie o conjunto completo desejado. Enviar um array vazio redefine todas as opções para o padrão.
- Método:
PUT - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/options
agency-hosting_php_list-versions-for-order
Lista as versões do PHP disponíveis para sites criados sob um pedido do Plano Agency, determinadas pelo servidor em que o pedido está hospedado. Use isto antes de criar um site; para um site que já existe, chame o endpoint de versões com escopo de site.
- Método:
GET - Caminho:
/api/agency-hosting/v1/orders/{order_id}/websites/php-settings/versions
agency-hosting_php_list-versions-for-website
Lista as versões do PHP para as quais um site do Plano Agency pode ser alternado. A versão que o site está executando atualmente é retornada como settings.php.version pelo endpoint de detalhes do site.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/versions
agency-hosting_php_update-website-version
Alterna um site do Plano Agency para uma versão diferente do PHP. Chame primeiro o endpoint de versões disponíveis para ver quais versões podem ser selecionadas. O site reinicia na nova versão, então as solicitações atendidas durante a alternância podem falhar e o código incompatível com a versão de destino quebrará.
- Método:
PATCH - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/php-settings/version
agency-hosting_website-setups_create
Provisiona um novo site em um dos seus pedidos de hospedagem do Plano Agency.
Escolha o datacenter, a stack (flavor) e a versão do PHP para o site. Opcionalmente, anexe
seu próprio domain — omita-o, defina-o como null ou deixe-o indisponível e um subdomínio
gratuito *.hostingersite.com será gerado — e/ou instale o WordPress fornecendo
os detalhes do wordpress (conta de administrador, título do site e idioma).
Configurações comuns:
- Site PHP simples:
flavordefinido comophp-fpm, comsettings.php.version; omitawordpressetype. - Site WordPress:
flavordefinido como a versão desejada do WordPress (ex.:wp-7.0), além do blocowordpress(conta de administrador, título, idioma). - Aplicativo frontend estático/Node.js:
flavordefinido comophp-fpmetypedefinido comonode-static.
O provisionamento é executado em segundo plano, então a resposta retorna imediatamente com um UUID de configuração que identifica o trabalho. O novo site se torna acessível quando o provisionamento termina.
- Método:
POST - Caminho:
/api/agency-hosting/v1/orders/{order_id}/websites/setups
agency-hosting_website-setups_status
Retorna o status atual de uma configuração de site do Plano Agency iniciada pelo endpoint de configurações.
Consulte este endpoint usando o setup_uuid retornado da solicitação de provisionamento até que
status se torne completed, momento em que website_uid identifica o novo site.
- Método:
GET - Caminho:
/api/agency-hosting/v1/orders/{order_id}/websites/setups/{setup_uuid}
agency-hosting_ssl_reinstall-website
Substitui o certificado Let's Encrypt do domínio: o certificado atual da plataforma, quando
registrado, é revogado e removido, então uma nova configuração é iniciada em segundo plano. Retorna
imediatamente; Get website SSL status reporta installing enquanto executa, depois active ou failed.
Retorna 422 para subdomínios gratuitos, quando um processo de certificado é registrado para o domínio (uma configuração com falha conta até ser limpa) ou quando o domínio atingiu o limite de três configurações em sete dias. Retorna 429 quando o mesmo domínio foi solicitado há menos de um minuto, 403 quando o site está suspenso ou bloqueado e 404 quando o site ou o domínio não existe.
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/reinstall
agency-hosting_ssl_install-website
Inicia uma configuração de certificado Let's Encrypt para o domínio e retorna imediatamente; a configuração é executada em
segundo plano. Get website SSL status reporta installing enquanto executa, depois active ou
failed; a entrada ssl_setup de List website processes mostra o mesmo progresso.
Retorna 422 quando o domínio já tem um certificado da plataforma que não expirou, quando um processo de certificado é registrado para o domínio (uma configuração com falha conta até ser limpa) ou quando o domínio atingiu o limite de três configurações em sete dias. Retorna 429 quando o mesmo domínio foi solicitado há menos de um minuto, 403 quando o site está suspenso ou bloqueado e 404 quando o site ou o domínio não existe.
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/setup
agency-hosting_ssl_website-status
Retorna o estado SSL de um domínio de um site do Plano Agency: o certificado status,
se o certificado foi enviado pelo cliente e quando deixa de ser válido.
installing significa que uma configuração de certificado está em execução ou tentando novamente; a entrada ssl_setup de
List website processes mostra o mesmo progresso. active significa que um certificado válido está
em vigor: enviado pelo cliente, emitido pela plataforma ou um certificado vitalício comprado para
o domínio. failed significa que a última configuração desistiu e nenhum certificado válido está em vigor.
expired significa que o certificado expirou. not_installed significa que o domínio não tem
certificado e nenhum processo de configuração. Retorna 404 quando o site ou o domínio não existe.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/status
agency-hosting_ssl_uninstall-website
Remove o certificado Let's Encrypt emitido pela plataforma do domínio: o certificado é revogado e excluído antes da resposta, então o domínio não é mais servido com um certificado da plataforma até que uma nova configuração seja concluída. Também é bem-sucedido quando o domínio não tem certificado da plataforma para remover. Certificados enviados (personalizados) não são afetados.
Retorna 422 quando um processo de certificado é registrado para o domínio (uma configuração com falha conta até ser limpa), 429 quando o mesmo domínio foi solicitado há menos de um minuto, 403 quando o site está suspenso ou bloqueado e 404 quando o site ou o domínio não existe.
- Método:
DELETE - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl
agency-hosting_websites_build-nodejs-assets
Compila e implanta um aplicativo Node.js para um site do Plano Agency a partir de um arquivo já enviado.
Envie o arquivo para o navegador de arquivos primeiro e forneça seu caminho relativo a partir da raiz do documento nesta solicitação. O conteúdo do site é substituído pelo resultado da compilação, que é implantado em public_html.
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/build-assets
agency-hosting_cache_clear-website
Limpa o cache de todos os domínios associados a um site do Plano Agency, incluindo seu domínio de visualização.
Esta operação limpa todos os tipos de cache do site.
- Método:
DELETE - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/cache
agency-hosting_cron-jobs_list-website
Retorna uma lista paginada de trabalhos cron configurados para um site do Plano Agency.
Cada entrada inclui a expressão de agendamento e o comando executado nesse agendamento.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs
agency-hosting_cron-jobs_create-website
Cria um trabalho cron para um site do Plano Agency a partir de uma expressão de agendamento e um comando.
Retorna o trabalho cron criado, incluindo seu uuid, que é necessário para excluir o trabalho cron.
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs
agency-hosting_cron-jobs_delete-website
Exclui permanentemente o trabalho cron identificado por seu uuid de um site do Plano Agency.
A operação é idempotente: excluir um trabalho cron que não existe é bem-sucedido sem erro.
- Método:
DELETE - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/cron-jobs/{uuid}
agency-hosting_databases_list-website
Retorna uma lista paginada de bancos de dados MySQL criados para um site do Plano Agency.
Cada entrada inclui os usuários não pertencentes ao sistema do banco de dados.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/databases
agency-hosting_databases_create-website
Cria um banco de dados MySQL com um usuário dedicado para um site do Plano Agency.
O nome do banco de dados, o nome de usuário e a senha devem ser fornecidos pelo chamador.
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/databases
agency-hosting_databases_delete-website
Exclui permanentemente um banco de dados MySQL e todos os seus dados de um site do Plano Agency, incluindo seus usuários.
A operação é idempotente: excluir um banco de dados que não existe é bem-sucedido sem erro.
- Método:
DELETE - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}
agency-hosting_databases_create-website-user
Cria um usuário para um banco de dados existente em um site do Plano Agency.
Cada banco de dados suporta um único usuário não pertencente ao sistema; criar um usuário para um banco de dados que já tem um falha.
- Método:
POST - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users
agency-hosting_databases_delete-website-user
Exclui permanentemente um usuário de banco de dados de um banco de dados de site do Plano Agency, revogando todo o acesso que ele tinha.
A operação é idempotente: excluir um usuário que não existe é bem-sucedido sem erro.
- Método:
DELETE - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/databases/{database_name}/users/{database_user_name}
agency-hosting_websites_get
Recupera informações detalhadas sobre um site específico do Plano Agency, incluindo configuração, status, metadados, detalhes do plano de hospedagem e cotas de recursos.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}
agency-hosting_websites_delete
Exclui permanentemente um site do Plano Agency. A exclusão é processada de forma assíncrona: o site é imediatamente transicionado para um estado de exclusão e os recursos do servidor subjacente são removidos em segundo plano.
- Método:
DELETE - Caminho:
/api/agency-hosting/v1/websites/{website_uid}
agency-hosting_websites_list-plan
Recupera uma lista paginada de sites do Plano Agency (H5G, Builder e Horizons) acessíveis ao cliente autenticado.
Este endpoint retorna sites de suas contas de hospedagem, bem como sites de outras contas de hospedagem de clientes que compartilharam acesso com você.
O formato da resposta difere por plataforma — consulte o campo platform em cada item.
Use website_types para listar apenas sites de um determinado tipo detectado, por exemplo, apenas
sites WordPress (website_types=wordpress) ou apenas sites Node.js
(website_types=nodejs). Combine com order_ids, states ou domain para resultados mais
direcionados.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites
agency-hosting_websites_list-processes
Lista processos assíncronos ativos e recentemente concluídos para um site do Plano Agency.
Cada processo tem um ID exclusivo (para rastreamento), um tipo e um status (em execução, concluído, com falha). Consulte este endpoint após iniciar operações assíncronas (configuração SSL, backups, clonagem) para rastrear o progresso.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/processes
agency-hosting_wordpress_change-version
Altera a versão principal do WordPress instalada em um site do Plano Agency para uma das versões disponíveis para instalação.
- Método:
PATCH - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/version
agency-hosting_wordpress_settings
Retorna as configurações atuais do WordPress para um site do plano Agency: versão do núcleo instalada, status do plugin LiteSpeed Cache, status do cache de objetos e status do modo de manutenção.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings
agency-hosting_wordpress_list-versions
Lista as versões do núcleo do WordPress disponíveis para instalação em um site do plano Agency.
- Método:
GET - Caminho:
/api/agency-hosting/v1/websites/{website_uid}/wordpress/settings/versions
hostinger-agent-readiness-mcp
agent-readiness_checks_list
Lista todas as verificações que uma varredura de prontidão do agente executa, com nome, categoria e peso.\n
Use para exibir o nome legível de cada check_id nos resultados de uma varredura.
- Método:
GET - Caminho:
/api/agent-readiness/v1/checks
agent-readiness_scans_run
Inicia uma varredura de quão pronto um site público está para agentes de IA descobrirem, lerem e agirem.\n
A varredura é assíncrona: esta operação apenas inicia a varredura, e a varredura retornada geralmente está pending
sem resultados ainda. Para obter os resultados, consulte a operação Get agent readiness scan com o mesmo
domínio a cada poucos segundos até que o status seja completed ou failed. A varredura em si é limitada a 60 segundos,
mais qualquer tempo de espera na fila. Uma varredura failed não é repetida; execute esta operação novamente.\n
Iniciar uma varredura para um domínio que já possui uma varredura pendente dos últimos 5 minutos
retorna essa varredura em vez de iniciar uma nova.
- Método:
POST - Caminho:
/api/agent-readiness/v1/scans
agent-readiness_scans_get
Obtém a varredura de prontidão do agente mais recente de um site.\n
Varreduras iniciadas com a operação Run agent readiness scan são assíncronas. Enquanto o status for
pending, os campos de resultado são nulos; aguarde alguns segundos e chame esta operação novamente até que o status seja
completed ou failed. Uma varredura failed não é repetida; execute a varredura novamente.\n
Uma varredura concluída tem uma pontuação de 0 a 100, uma nota por letra, uma pontuação por categoria e o resultado de cada
verificação com a evidência encontrada e como corrigi-la. Os nomes das verificações são listados pela operação List checks.\n
Retorna 404 quando o domínio nunca foi varrido; use a operação Run agent readiness scan primeiro.
- Método:
GET - Caminho:
/api/agent-readiness/v1/scans/{domain}
hostinger-billing-mcp
billing_catalog_list
Recupera os itens do catálogo disponíveis para pedido.
Os preços nos itens do catálogo são exibidos em centavos (sem ponto flutuante),
ex.: float 17.99 é exibido como inteiro 1799.
Use este endpoint para visualizar os serviços e preços disponíveis antes de fazer pedidos.
- Método:
GET - Caminho:
/api/billing/v1/catalog
billing_orders_create-purchase
Cria um pedido de compra para qualquer produto Hostinger.
Este endpoint unificado faz um pedido para um ou mais itens do catálogo e
funciona em todos os produtos Hostinger, aproveitando a infraestrutura de cobrança
existente. Use o endpoint de catálogo para consultar
os valores item_id disponíveis para compra.
Se nenhum método de pagamento for fornecido, seu método de pagamento padrão será usado automaticamente.
Se a resposta for 202 Accepted, o pagamento ainda está sendo processado e o pedido será
concluído de forma assíncrona assim que o pagamento for confirmado.
Este endpoint apenas faz o pedido. O provisionamento específico do produto (ex.: configuração de VPS ou registro de domínio) não é realizado aqui — assim que o pedido for concluído, use os endpoints de produto relevantes ou o hPanel para finalizar a configuração.
Use este endpoint para comprar qualquer produto disponível no catálogo.
- Método:
POST - Caminho:
/api/billing/v1/orders
billing_payment-methods_set-default
Define o método de pagamento padrão para sua conta.
Use este endpoint para configurar o método de pagamento principal para pedidos futuros.
- Método:
POST - Caminho:
/api/billing/v1/payment-methods/{paymentMethodId}
billing_payment-methods_delete
Exclui um método de pagamento da sua conta.
Use este endpoint para remover métodos de pagamento não utilizados das contas de usuário.
- Método:
DELETE - Caminho:
/api/billing/v1/payment-methods/{paymentMethodId}
billing_payment-methods_list
Recupera os métodos de pagamento disponíveis que podem ser usados para fazer novos pedidos.
Se você quiser adicionar um novo método de pagamento, use o hPanel.
Use este endpoint para visualizar as opções de pagamento disponíveis antes de criar pedidos.
- Método:
GET - Caminho:
/api/billing/v1/payment-methods
billing_subscriptions_list
Recupera uma lista de todas as assinaturas associadas à sua conta.
Use este endpoint para monitorar serviços ativos e status de cobrança.
- Método:
GET - Caminho:
/api/billing/v1/subscriptions
billing_subscriptions_disable-auto-renewal
Desativa a renovação automática de uma assinatura.
Use este endpoint ao desativar a renovação automática de uma assinatura.
- Método:
DELETE - Caminho:
/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable
billing_subscriptions_enable-auto-renewal
Ativa a renovação automática de uma assinatura.
Use este endpoint ao ativar a renovação automática de uma assinatura.
- Método:
PATCH - Caminho:
/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable
billing_subscriptions_renew
Cria um pedido de renovação para uma assinatura Hostinger existente.
Este endpoint faz um pedido de renovação para uma única assinatura, aproveitando
a infraestrutura de cobrança existente. Use o
endpoint de assinaturas para consultar os
valores subscriptionId disponíveis para renovação.
Se nenhum método de pagamento for fornecido, seu método de pagamento padrão será usado automaticamente.
Se a resposta for 202 Accepted, o pagamento ainda está sendo processado e a renovação será
concluída de forma assíncrona assim que o pagamento for confirmado.
Use este endpoint para renovar qualquer assinatura disponível na sua conta.
- Método:
POST - Caminho:
/api/billing/v1/subscriptions/{subscriptionId}/renew
hostinger-dns-mcp
dns_snapshots_get
Recupera um snapshot DNS específico com o conteúdo dos registros da zona DNS.
Use este endpoint para visualizar configurações DNS históricas de domínios.
- Método:
GET - Caminho:
/api/dns/v1/snapshots/{domain}/{snapshotId}
dns_snapshots_list
Recupera snapshots DNS de um domínio.
Use este endpoint para visualizar os pontos de backup DNS disponíveis para restauração.
- Método:
GET - Caminho:
/api/dns/v1/snapshots/{domain}
dns_snapshots_restore
Restaura a zona DNS para o snapshot selecionado.
Use este endpoint para reverter o DNS do domínio para uma configuração anterior.
- Método:
POST - Caminho:
/api/dns/v1/snapshots/{domain}/{snapshotId}/restore
dns_records_list
Recupera os registros da zona DNS de um domínio específico.
Use este endpoint para visualizar a configuração DNS atual para gerenciamento de domínio.
- Método:
GET - Caminho:
/api/dns/v1/zones/{domain}
dns_records_update
Atualiza os registros DNS do domínio selecionado.
Usar overwrite = true substituirá os registros existentes pelos fornecidos.
Caso contrário, os registros existentes serão atualizados e novos registros serão adicionados.
Use este endpoint para modificar a configuração DNS do domínio.
- Método:
PUT - Caminho:
/api/dns/v1/zones/{domain}
dns_records_delete
Exclui registros DNS do domínio selecionado.
Para filtrar quais registros excluir, adicione o name do registro e o type ao filtro.
Vários filtros podem ser fornecidos em uma única solicitação.
Se você tiver vários registros com o mesmo nome e tipo, e quiser excluir apenas parte deles,
consulte o endpoint Update zone records.
Use este endpoint para remover registros DNS específicos de domínios.
- Método:
DELETE - Caminho:
/api/dns/v1/zones/{domain}
dns_records_reset
Redefine a zona DNS para os registros padrão.
Use este endpoint para restaurar o DNS do domínio para a configuração original.
- Método:
POST - Caminho:
/api/dns/v1/zones/{domain}/reset
dns_records_validate
Valida registros DNS antes da atualização do domínio selecionado.
Se a validação for bem-sucedida, a resposta conterá o código 200 Success.
Se houver erro de validação, a resposta falhará com o código 422 Validation error.
Use este endpoint para verificar a validade dos registros DNS antes de aplicar alterações.
- Método:
POST - Caminho:
/api/dns/v1/zones/{domain}/validate
hostinger-domains-mcp
domains_verifications_direct
Recupera uma lista de verificações de domínio pendentes e concluídas.
- Método:
GET - Caminho:
/api/v2/direct/verifications/active
domains_availability_suggest-names-from-description
Sugere nomes de domínio disponíveis com base em uma descrição em texto livre do seu projeto.
As sugestões são geradas por um modelo de IA, portanto, diferem entre chamadas.
O endpoint tem limite de taxa de 90 solicitações por minuto.
Use este endpoint para encontrar um nome de domínio quando você só sabe sobre o que é o site.
- Método:
POST - Caminho:
/api/domains/v1/availability/alternatives-from-description
domains_availability_suggest-names-from
Sugere nomes de domínio disponíveis com base em um nome de domínio que você já tem em mente.
As sugestões são geradas por um modelo de IA, portanto, diferem entre chamadas.
O endpoint tem limite de taxa de 90 solicitações por minuto.
Use este endpoint quando o domínio desejado estiver ocupado e você precisar de alternativas próximas.
- Método:
POST - Caminho:
/api/domains/v1/availability/alternatives-from-domain
domains_availability_check
Verifica a disponibilidade de nomes de domínio em vários TLDs.
Vários TLDs podem ser verificados de uma vez.
Se você quiser domínios alternativos na resposta, forneça apenas um TLD e defina with_alternatives como true.
Os TLDs devem ser fornecidos sem o ponto inicial (ex.: com, net, org).
O endpoint tem limite de taxa de 90 solicitações por minuto.
Use este endpoint para verificar a disponibilidade do domínio antes da compra.
- Método:
POST - Caminho:
/api/domains/v1/availability
domains_forwarding_get
Recupera os dados de encaminhamento de domínio.
Use este endpoint para visualizar a configuração de redirecionamento atual dos domínios.
- Método:
GET - Caminho:
/api/domains/v1/forwarding/{domain}
domains_forwarding_update
Atualiza a configuração de encaminhamento de domínio.
Use este endpoint para modificar a configuração de redirecionamento existente dos domínios.
- Método:
PUT - Caminho:
/api/domains/v1/forwarding/{domain}
domains_forwarding_delete
Exclui os dados de encaminhamento de domínio.
Use este endpoint para remover a configuração de redirecionamento dos domínios.
- Método:
DELETE - Caminho:
/api/domains/v1/forwarding/{domain}
domains_forwarding_create
Cria a configuração de encaminhamento de domínio.
Use este endpoint para configurar redirecionamentos de domínio para outras URLs.
- Método:
POST - Caminho:
/api/domains/v1/forwarding
domains_whois_pending-irtp-verification
Recupera uma verificação IRTP pendente para um domínio.
Tanto o registrante antigo quanto o novo devem confirmá-la antes que a alteração de WHOIS entre em vigor.
Use este endpoint para verificar o status de uma alteração de WHOIS aguardando confirmação do registrante.
- Método:
GET - Caminho:
/api/domains/v1/irtp/{domain}
domains_whois_cancel-pending-irtp-verification
Cancela uma verificação IRTP pendente.
Use este endpoint para desistir de uma alteração de WHOIS que está travada aguardando confirmação do registrante, por exemplo, quando o e-mail de confirmação não pode ser recebido, sem esperar a expiração de 5 dias.
- Método:
DELETE - Caminho:
/api/domains/v1/irtp/{domain}
domains_move_incoming
Recupera a transferência recebida para um domínio especificado.
Retorna 404 quando nenhuma conta está transferindo este domínio para você.
Use este endpoint para verificar se um domínio endereçado a você ainda está aguardando aceitação.
- Método:
GET - Caminho:
/api/domains/v1/move/incoming/{domain}
domains_move_accept-incoming
Aceita uma transferência recebida para um domínio especificado.
Os perfis WHOIS fornecidos se tornam os contatos do domínio, portanto, devem pertencer à sua conta e atender aos requisitos do TLD. Apenas os tipos de contato que o domínio realmente usa são aplicados, mas todos os quatro IDs de perfil devem ser fornecidos.
A transferência ainda deve estar aguardando sua decisão; transferências já aceitas
não podem ser aceitas novamente.
Aceitar não conclui a transferência. Um e-mail de confirmação é enviado para o endereço de e-mail do novo contato do proprietário, e o domínio só muda de mãos após a confirmação ser feita a partir desse e-mail. Até lá, a transferência permanece no status activating, que pode ser acompanhado pelo endpoint de transferências recebidas.
Use este endpoint para assumir a propriedade de um domínio oferecido a você.
- Método:
PUT - Caminho:
/api/domains/v1/move/incoming/{domain}
domains_move_reject-incoming
Rejeitar uma transferência recebida para um domínio específico.
O domínio permanece na conta que iniciou a transferência. Transferências que você já aceitou não podem mais ser rejeitadas.
Use este endpoint para recusar um domínio que você não deseja assumir.
- Método:
DELETE - Caminho:
/api/domains/v1/move/incoming/{domain}
domains_move_incoming-list
Recuperar todos os domínios que outras contas Hostinger estão transferindo para a sua conta.
Transferências de todos os status são retornadas, incluindo as que já foram concluídas.
Use este endpoint para encontrar domínios aguardando sua aceitação.
- Método:
GET - Caminho:
/api/domains/v1/move/incoming
domains_move_outgoing
Recuperar a transferência de saída para um domínio específico.
Retorna 404 quando o domínio não possui uma transferência em andamento.
Use este endpoint para acompanhar o status de uma transferência que você iniciou para um único domínio.
- Método:
GET - Caminho:
/api/domains/v1/move/outgoing/{domain}
domains_move_start-outgoing
Iniciar uma transferência de um domínio específico para outra conta Hostinger.
A conta receptora deve já existir e aceitar a transferência antes que o domínio mude de mãos.
O domínio deve estar ativo. A assinatura à qual ele pertence é resolvida automaticamente, e a solicitação é rejeitada com um código de status 404 quando o domínio não possui uma assinatura de domínio própria.
Domínios protegidos por proteção premium exigem uma etapa de verificação adicional; tais solicitações são rejeitadas com um código de status 428.
Use este endpoint para entregar um domínio a outro usuário Hostinger.
- Método:
POST - Caminho:
/api/domains/v1/move/outgoing/{domain}
domains_move_cancel-outgoing
Cancelar uma transferência de saída para um domínio específico.
A transferência só pode ser cancelada enquanto a conta receptora ainda não a aceitou. O domínio permanece na sua conta.
Use este endpoint para retirar uma transferência que você não deseja mais concluir.
- Método:
DELETE - Caminho:
/api/domains/v1/move/outgoing/{domain}
domains_move_outgoing-list
Recuperar todos os domínios que você está transferindo para outras contas Hostinger.
Apenas transferências que ainda não foram concluídas são retornadas.
Use este endpoint para acompanhar transferências que você iniciou e as contas para as quais elas são destinadas.
- Método:
GET - Caminho:
/api/domains/v1/move/outgoing
domains_portfolio_authorization-code
Recuperar o código de autorização (EPP) para um domínio específico para que ele possa ser transferido para fora da Hostinger para outro registrador.
Solicitar um novo código invalida qualquer código recuperado anteriormente.
Use este endpoint para obter o código necessário para transferir um domínio para outro registrador.
- Método:
GET - Caminho:
/api/domains/v1/portfolio/{domain}/auth-code
domains_portfolio_claim-free
Reivindicar um domínio gratuito disponível na sua conta e registrá-lo.
Diferente de comprar um domínio, isso consome um domínio gratuito que você já possui, portanto nenhum método de pagamento é necessário.
Uma resposta bem-sucedida significa que o domínio está registrado. Se o registro falhar, faça login no hPanel e verifique o status do registro do domínio.
Se nenhuma informação WHOIS for fornecida, as informações de contato padrão para esse TLD serão usadas. Antes de fazer a solicitação, garanta que as informações WHOIS para o TLD desejado existam na sua conta.
Alguns TLDs exigem que additional_details seja fornecido, e estes serão validados antes da reivindicação.
Solicitações que não podem ser atendidas são rejeitadas com um código de erro no corpo da resposta, por exemplo 2037 quando nenhum domínio gratuito está disponível.
Use este endpoint para registrar um domínio usando um domínio gratuito da sua conta.
- Método:
POST - Caminho:
/api/domains/v1/portfolio/claim
domains_portfolio_enable-lock
Ativar o bloqueio de domínio para o domínio.
Quando o bloqueio de domínio está ativado, o domínio não pode ser transferido para outro registrador sem antes desativar o bloqueio.
Use este endpoint para proteger domínios contra transferências não autorizadas.
- Método:
PUT - Caminho:
/api/domains/v1/portfolio/{domain}/domain-lock
domains_portfolio_disable-lock
Desativar o bloqueio de domínio para o domínio.
O bloqueio de domínio precisa ser desativado antes de transferir o domínio para outro registrador.
Use este endpoint para preparar domínios para transferência para outros registradores.
- Método:
DELETE - Caminho:
/api/domains/v1/portfolio/{domain}/domain-lock
domains_portfolio_get
Recuperar informações detalhadas para o domínio especificado.
Use este endpoint para visualizar a configuração e o status abrangentes do domínio.
- Método:
GET - Caminho:
/api/domains/v1/portfolio/{domain}
domains_portfolio_list
Recuperar todos os domínios associados à sua conta.
Use este endpoint para visualizar o portfólio de domínios do usuário.
- Método:
GET - Caminho:
/api/domains/v1/portfolio
domains_portfolio_purchase
Comprar e registrar um novo nome de domínio.
Se o registro falhar, faça login no hPanel e verifique o status do registro do domínio.
Se nenhum método de pagamento for fornecido, seu método de pagamento padrão será usado automaticamente.
Se a resposta for 202 Accepted, o pagamento ainda está sendo processado e o domínio não foi registrado. Quando o pedido for concluído, registre o domínio no hPanel.
Se nenhuma informação WHOIS for fornecida, as informações de contato padrão para esse TLD serão usadas. Antes de fazer a solicitação, garanta que as informações WHOIS para o TLD desejado existam na sua conta.
Alguns TLDs exigem que additional_details seja fornecido, e estes serão validados antes de concluir a compra.
Use este endpoint para registrar novos domínios para usuários.
- Método:
POST - Caminho:
/api/domains/v1/portfolio
domains_portfolio_enable-privacy-protection
Ativar a proteção de privacidade para o domínio.
Quando a proteção de privacidade está ativada, as informações pessoais do proprietário do domínio ficam ocultas do banco de dados público WHOIS.
Use este endpoint para proteger as informações pessoais do proprietário do domínio da visualização pública.
- Método:
PUT - Caminho:
/api/domains/v1/portfolio/{domain}/privacy-protection
domains_portfolio_disable-privacy-protection
Desativar a proteção de privacidade para o domínio.
Quando a proteção de privacidade está desativada, as informações pessoais do proprietário do domínio ficam visíveis no banco de dados público WHOIS.
Use este endpoint para tornar as informações do proprietário do domínio publicamente visíveis.
- Método:
DELETE - Caminho:
/api/domains/v1/portfolio/{domain}/privacy-protection
domains_portfolio_renewal-information
Recuperar informações de renovação para um domínio específico, incluindo seu status e data de expiração atual.
Use este endpoint para construir automação de renovação e monitoramento de expiração para um único domínio.
- Método:
GET - Caminho:
/api/domains/v1/portfolio/{domain}/renewal
domains_portfolio_complete-setup
Registrar um domínio que você já pagou, mas que ainda não foi configurado.
Use este endpoint quando um pedido foi concluído sem registrar o domínio, por exemplo quando Purchase new domain retornou 202 Accepted e o domínio foi adicionado à sua conta sem ser registrado, ou quando uma tentativa de configuração anterior falhou. Nenhum novo pedido é feito e nenhum pagamento é cobrado: a assinatura que você já possui é usada, pelo período que você já pagou.
Um domínio fica aguardando configuração quando os detalhes necessários para registrá-lo estavam ausentes ou inválidos quando o pedido foi concluído. Domínios pedidos em outros lugares podem estar aguardando configuração pelo mesmo motivo. Complete as informações ausentes e então chame este endpoint. Se o pedido em si ainda não foi concluído, o domínio não está na sua conta; aguarde até que ele apareça em Get domain list.
Se domain_contacts for omitido, o perfil WHOIS padrão desse TLD é usado para todas as quatro funções. O perfil deve existir e estar completo para o TLD; um perfil incompleto é o motivo mais comum para um domínio ficar aguardando configuração. Crie um com Create WHOIS profile.
Alguns TLDs exigem additional_details. Estes são validados antes da configuração, portanto um valor ausente ou inválido é rejeitado sem que nenhum registro seja tentado.
O domínio é configurado com os servidores de nomes padrão e sem proteção de privacidade. Use Update domain nameservers e Enable privacy protection posteriormente para alterar qualquer um deles.
Uma resposta bem-sucedida significa que a solicitação de configuração foi aceita, não que o domínio já está registrado. Consulte Get domain list para ver o resultado; o domínio aparece em Get domain details somente depois de registrado.
Use este endpoint para concluir o registro de um domínio que está aguardando configuração na sua conta.
- Método:
POST - Caminho:
/api/domains/v1/portfolio/{domain}/setup
domains_portfolio_update-nameservers
Definir servidores de nomes para um domínio específico.
Esteja ciente de que uma configuração inadequada de servidores de nomes pode levar o domínio a ficar irresolvível ou indisponível.
Use este endpoint para configurar hospedagem DNS personalizada para domínios.
- Método:
PUT - Caminho:
/api/domains/v1/portfolio/{domain}/nameservers
domains_transfer_claim-free
Reivindicar uma transferência de domínio gratuita disponível na sua conta e iniciar a transferência.
Diferente de comprar uma transferência, isso consome uma transferência de domínio gratuita que você já possui, portanto nenhum método de pagamento é necessário.
Antes de fazer a solicitação, desbloqueie o domínio no registrador atual e obtenha seu código de autorização. A transferência é validada primeiro, portanto domínios que não podem ser transferidos são rejeitados antes que a transferência gratuita seja consumida.
Uma resposta bem-sucedida significa que a transferência foi iniciada. A conclusão depende do registrador atual e pode ser acompanhada pelo endpoint de lista de transferências.
Se nenhuma informação WHOIS for fornecida, as informações de contato padrão para esse TLD serão usadas. Antes de fazer a solicitação, garanta que as informações WHOIS para o TLD desejado existam na sua conta.
Solicitações que não podem ser atendidas são rejeitadas com um código de erro no corpo da resposta.
Use este endpoint para transferir um domínio usando uma transferência de domínio gratuita da sua conta.
- Método:
POST - Caminho:
/api/domains/v1/transfers/claim
domains_transfer_get
Recuperar a transferência para um domínio específico.
Use este endpoint para acompanhar uma transferência de registrador recebida ou enviada e seu status.
- Método:
GET - Caminho:
/api/domains/v1/transfers/{domain}
domains_transfer_list
Recuperar todas as transferências de domínio no seu portfólio.
Use este endpoint para monitorar transferências de registrador recebidas e enviadas em seus domínios.
- Método:
GET - Caminho:
/api/domains/v1/transfers
domains_transfer_start
Transferir um domínio de outro registrador para a sua conta.
A transferência é executada em um serviço de transferência de domínio que você já comprou.
Antes de fazer a solicitação, desbloqueie o domínio no registrador atual e obtenha seu código de autorização.
Uma resposta bem-sucedida significa que a transferência foi iniciada. A conclusão depende do registrador atual e pode ser acompanhada pelo endpoint de lista de transferências.
Se nenhuma informação WHOIS for fornecida, as informações de contato padrão para esse TLD serão usadas. Antes de fazer a solicitação, garanta que as informações WHOIS para o TLD desejado existam na sua conta.
Use este endpoint para trazer domínios registrados em outros lugares para a sua conta.
- Método:
POST - Caminho:
/api/domains/v1/transfers
domains_whois_change-for
Alterar o perfil de contato WHOIS para um domínio.
Redireciona as funções de contato fornecidas para um novo perfil WHOIS e envia a alteração ao registro. O perfil atualmente atribuído a essas funções é resolvido automaticamente; a solicitação falha se as funções fornecidas não estiverem todas no mesmo perfil atualmente.
Alterar campos sensíveis à transferência no contato do proprietário inicia uma verificação IRTP.
A alteração é processada de forma assíncrona.
Use este endpoint para mover um domínio registrado para informações de contato diferentes.
- Método:
PUT - Caminho:
/api/domains/v1/whois/change
domains_whois_set-as-default
Definir perfil de contato WHOIS como padrão. O perfil padrão é pré-selecionado para o TLD ao qual pertence ao registrar novos domínios.
Use este endpoint para evitar escolher informações de contato a cada registro.
- Método:
PUT - Caminho:
/api/domains/v1/whois/default/{whoisId}
domains_whois_unset-default
Desativa o perfil de contato WHOIS como padrão.
O perfil em si é mantido; ele apenas não é mais pré-selecionado para seu TLD.
Use este endpoint para parar de reutilizar informações de contato em novos registros.
- Método:
DELETE - Caminho:
/api/domains/v1/whois/default/{whoisId}
domains_whois_get
Recupera um perfil de contato WHOIS.
Use este endpoint para visualizar as informações de contato do registro de domínio.
- Método:
GET - Caminho:
/api/domains/v1/whois/{whoisId}
domains_whois_delete
Exclui o perfil de contato WHOIS.
Use este endpoint para remover perfis de contato não utilizados da conta.
- Método:
DELETE - Caminho:
/api/domains/v1/whois/{whoisId}
domains_whois_list
Recupera perfis de contato WHOIS.
Use este endpoint para visualizar os perfis de contato disponíveis para registro de domínio.
- Método:
GET - Caminho:
/api/domains/v1/whois
domains_whois_create
Cria um perfil de contato WHOIS.
Use este endpoint para adicionar novas informações de contato para registro de domínio.
- Método:
POST - Caminho:
/api/domains/v1/whois
domains_whois_usage
Recupera a lista de domínios onde o perfil de contato WHOIS fornecido é usado.
Use este endpoint para visualizar quais domínios usam perfis de contato específicos.
- Método:
GET - Caminho:
/api/domains/v1/whois/{whoisId}/usage
hostinger-ecommerce-mcp
ecommerce_discounts_list
Lista os descontos de uma loja. Filtre por texto livre sobre código e nome, ou por estado desativado. Valores para descontos fixos são inteiros na menor unidade monetária; descontos percentuais possuem um valor inteiro entre 1 e 100.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores/{store_id}/discounts
ecommerce_discounts_create
Cria um desconto para uma loja. Descontos fixos usam um valor na menor unidade monetária (por exemplo, $10 é 1000); descontos percentuais usam um valor inteiro entre 1 e 100. Descontos de frete grátis ignoram o valor. Retorna o desconto criado.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/discounts
ecommerce_miscellaneous_custom-storefront-setup-instructions
Recupera instruções de configuração passo a passo, formatadas como Markdown, para conectar um canal de vendas personalizado à sua loja e manter catálogo, pedidos, envio e pagamentos sincronizados por meio da API de Ecommerce.
- Método:
GET - Caminho:
/api/ecommerce/v1/miscellaneous/custom-storefront-instructions
ecommerce_orders_cancel
Cancela o pedido e, opcionalmente, envia um e-mail ao cliente. Retorna o resumo do pedido atualizado.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/cancel
ecommerce_orders_fulfil
Cria um atendimento para o pedido e anexa o rastreamento em uma única chamada. Omita itens para atender todos os itens não atendidos restantes. Retorna o resumo do pedido atualizado.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}/fulfill
ecommerce_orders_list-store
Lista os pedidos de uma loja do mais recente para o mais antigo como resumos. Filtre por status, status de pagamento ou atendimento, e-mail do cliente, número do pedido ou consulta de texto livre. Valores estão na menor unidade monetária. Recupere um único pedido para seus itens de linha, endereços e atendimentos.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores/{store_id}/orders
ecommerce_orders_retrieve
Recupera um pedido completo: itens de linha (cada um com o id que o endpoint de atendimento precisa), endereços, detalhamento de totais e atendimentos com rastreamento. Valores estão na menor unidade monetária.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores/{store_id}/orders/{order_id}
ecommerce_payments_enable-manual-method
Ativa um método de pagamento manual para que a loja possa aceitar pedidos sem um provedor de pagamento online.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/payment-methods/manual
ecommerce_payments_create-provider-connect-link
Cria um link de integração para conectar um gateway de pagamento à loja. Retorna a URL de integração do gateway para o comerciante abrir e um link profundo para o admin da loja.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/payment-providers/{provider_id}/connect-link
ecommerce_payments_list-store-providers
Lista os provedores de pagamento de uma loja, divididos entre provedores já conectados à loja e gateways disponíveis para instalação. Nunca expõe credenciais, segredos ou configuração do gateway.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores/{store_id}/payment-providers
ecommerce_products_create-image-upload-url
Retorna uma URL assinada para enviar uma imagem de produto (POST multipart/form-data). Em seguida, chame o endpoint attach-image com o object_name retornado para escanear e anexá-la ao produto.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images/upload-url
ecommerce_products_delete
Exclui um produto e suas variantes da loja. Um produto por assinatura com assinantes ativos é arquivado em vez de excluído para que seus dados permaneçam disponíveis.
- Método:
DELETE - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}
ecommerce_products_update
Atualiza o nome, descrição, status, configurações de SEO ou coleções de um produto. Defina o status como published para torná-lo comprável, draft para ocultá-lo ou archived para retirá-lo. Configurações de SEO (título, descrição, slug) omitidas mantêm seus valores. collection_changes adiciona ou remove coleções sem tocar nas demais. Variantes, preços e estoque são gerenciados pelos endpoints de variantes, não aqui. Retorna o resumo do produto atualizado.
- Método:
PATCH - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}
ecommerce_products_create-digital
Cria um produto digital publicado com uma única variante e um link de download externo opcional.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/digital
ecommerce_products_list
Lista os produtos de uma loja do mais recente para o mais antigo como resumos enxutos (nome, status, miniatura, contagem de variantes e faixa de preço). Preços são inteiros na menor unidade monetária e ficam nas variantes. Filtre por status, texto livre ou um conjunto de ids de produto. Use include=variants para incorporar as variantes de cada produto com preços e estoque, e include=media para incorporar sua mídia.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores/{store_id}/products
ecommerce_products_create-physical
Cria um produto físico publicado com uma única variante precificada na moeda da loja.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/physical
ecommerce_products_upload-and-attach-image
Busca uma imagem raster (JPEG, PNG, GIF ou WebP, máx. 15MB) de uma URL e a anexa a um produto em uma única chamada. Downloads de imagem exigem HTTPS na porta 443 sem credenciais incorporadas. No máximo um redirecionamento é permitido, e seu destino deve atender aos mesmos requisitos. Destinos de rede privados ou reservados, URLs não suportadas e cadeias de redirecionamento mais longas são rejeitados. A imagem é verificada por vírus e validada por conteúdo, depois armazenada no CDN. Defina is_thumbnail para torná-la a imagem principal do produto.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/images
ecommerce_sales-channels_list
Lista os canais de vendas ativos de uma loja com seus metadados completos.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores/{store_id}/sales-channels
ecommerce_sales-channels_create
Cria um canal de vendas para uma loja. Um canal "custom" é headless: crie seu próprio frontend e mantenha seu catálogo, pedidos, envio e pagamentos sincronizados por meio da API de Ecommerce. Um canal "quick-link" é uma loja hospedada de uma página cujo handle é gerado automaticamente.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/sales-channels
ecommerce_sales-channels_update
Atualiza um canal de vendas personalizado. O name voltado ao comerciante e o url
público (retornado como o domain do canal) podem ser alterados. Passe null para limpar um valor.
- Método:
PATCH - Caminho:
/api/ecommerce/v1/stores/{store_id}/sales-channels/{sales_channel_id}
ecommerce_shipping_set-store
Define o preço de envio de taxa fixa para uma loja, criando a zona de envio se ela ainda não existir.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/shipping
ecommerce_stores_delete
Exclui de forma suave uma loja de propriedade da sua conta.
Os dados subjacentes da loja são preservados; apenas a loja é marcada como excluída.
- Método:
DELETE - Caminho:
/api/ecommerce/v1/stores/{store_id}
ecommerce_stores_list
Recupera as lojas associadas à sua conta.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores
ecommerce_stores_create
Cria uma nova loja para sua conta.
Um canal de vendas principal é criado junto com a loja.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores
ecommerce_stores_metadata
Obtém os metadados de prontidão de uma loja: se métodos de pagamento e envio estão configurados, além da moeda padrão. Útil para verificar pré-requisitos antes de construir uma vitrine.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores/{store_id}/metadata
ecommerce_product-variants_update-in-batch
Atualiza até 100 variantes existentes no local por id — título, SKU, estoque, rastreamento de estoque e preços. Variantes omitidas da solicitação permanecem intactas. Preços substituem os preços existentes da variante por completo. Retorna as variantes atualizadas.
- Método:
PATCH - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants/batch
ecommerce_product-variants_delete
Exclui uma única variante do produto.
- Método:
DELETE - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants/{variant_id}
ecommerce_product-variants_list
Lista as variantes de um produto, ordenadas por classificação, com suas opções, preços e estoque. Preços são inteiros na menor unidade monetária e ficam nas variantes.
- Método:
GET - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants
ecommerce_product-variants_create
Adiciona uma variante a um produto em uma ou mais dimensões de opção (por exemplo, Tamanho, Cor). Opções ausentes no produto são criadas automaticamente; forneça um valor para cada opção que o produto já possui. Preços são inteiros na menor unidade monetária e usam como padrão a moeda da loja. Retorna a variante criada.
- Método:
POST - Caminho:
/api/ecommerce/v1/stores/{store_id}/products/{product_id}/variants
hostinger-horizons-mcp
horizons_websites_clone
Clone um site Hostinger Horizons em um novo site.\n
Use esta ferramenta quando o usuário quiser uma cópia de um site existente, por exemplo, para testar
alterações sem tocar no original.\n
Esta ferramenta retorna o ID e a URL da cópia recém-criada.
O site original permanece intacto.\n
Para editar a cópia, use a ferramenta Edit website com o ID do site retornado, ou o usuário pode
abrir a URL do site fornecida na interface Hostinger Horizons.
- Método:
POST - Caminho:
/api/horizons/v1/websites/{websiteId}/clone
horizons_websites_list
Lista os sites Hostinger Horizons que o usuário possui.\n Use esta ferramenta quando o usuário perguntar quais sites ele tem, ou quando você precisar de um ID de site antes de editar, publicar ou clonar um site.\n Cada site é retornado com seu ID, status, domínio e a URL para abri-lo na interface Hostinger Horizons.\n A lista completa de sites é retornada em uma única resposta — ela não é paginada.
- Método:
GET - Caminho:
/api/horizons/v1/websites
horizons_websites_create
Crie um novo site Hostinger Horizons a partir da mensagem fornecida.\n
Use esta ferramenta quando o usuário pedir para criar um site, página de destino, blog
ou qualquer outro tipo de aplicação.\n
Esta ferramenta inicia o processo de criação do site e retorna uma URL e um ID do site.
A geração acontece de forma assíncrona.\n
Após invocar esta ferramenta, sua resposta no chat deve ter EXATAMENTE 1 frase resumindo
que o Hostinger Horizons está agora criando o site do usuário e que ele ficará pronto em alguns minutos,
e você deve fornecer a URL do site ao usuário imediatamente.
Não escreva código.\n\nPara editar depois, use a ferramenta Edit website com o ID
do site retornado, ou o usuário pode acessar a interface do Hostinger Horizons na URL do site fornecida.
Se a chamada da ferramenta falhar com um erro, você deve fornecer uma explicação clara do erro
e não gerar código você mesmo no chat.
\n
RESTRIÇÕES DE PILHA TECNOLÓGICA (RIGOROSAMENTE APLICADAS):\n
O ambiente está limitado às seguintes tecnologias.
Você NÃO DEVE usar, sugerir ou implementar qualquer tecnologia fora desta lista:\n
\n
-
Linguagem: JavaScript SOMENTE.
-
Linguagens como TypeScript, Rust, Python, Java, PHP, etc., são ESTRITAMENTE PROIBIDAS.\n
-
Framework: React.\n
-
Navegação: React Router.\n
-
Estilização: TailwindCSS.\n
-
Componentes: shadcn/ui (construído com primitivas @radix-ui).\n
-
Ícones: Lucide React.\n
-
Animações: Framer Motion.\n \n BACKEND E ARMAZENAMENTO DE DADOS:\n
-
O backend integrado do Horizons é a solução EXCLUSIVA para armazenamento persistente de dados, autenticação e necessidades de banco de dados.\n
-
Bancos de dados locais (SQLite, MySQL, etc.) são ESTRITAMENTE PROIBIDOS.\n
-
Serviços de terceiros (Firebase, AWS Amplify) são permitidos SOMENTE se explicitamente solicitados pelo usuário.\n \n MAPAS:\n
-
OpenStreetMap é o provedor padrão.\n
-
Provedores alternativos (Google Maps, Mapbox) são permitidos SOMENTE se explicitamente solicitados pelo usuário.\n
-
Método:
POST -
Caminho:
/api/horizons/v1/websites
horizons_websites_edit
Edite um site Hostinger Horizons existente com uma mensagem de acompanhamento.\n Use esta ferramenta quando o usuário quiser alterar, estender ou corrigir um site que já existe.\n Esta ferramenta enfileira as alterações solicitadas e retorna a URL e o ID do site. As alterações são aplicadas de forma assíncrona.\n Após invocar esta ferramenta, sua resposta no chat deve ter EXATAMENTE 1 frase resumindo que o Hostinger Horizons está agora aplicando as alterações solicitadas e que elas estarão prontas em alguns minutos, e você deve fornecer a URL do site ao usuário imediatamente. Não escreva código.\n Se a chamada da ferramenta falhar com um erro, você deve fornecer uma explicação clara do erro e não gerar código você mesmo no chat.
- Método:
POST - Caminho:
/api/horizons/v1/websites/{websiteId}/messages
horizons_websites_publish
Publique um site Hostinger Horizons para que suas alterações mais recentes entrem no ar.\n
Use esta ferramenta quando o usuário pedir para publicar, implantar ou colocar o site no ar.\n
Esta ferramenta inicia o processo de publicação e retorna a URL onde o site estará no ar.
A publicação acontece de forma assíncrona e leva alguns minutos.\n
Defina is_template somente quando o usuário pedir explicitamente para compartilhar o site como modelo:
true adiciona um banner "Usar modelo" às páginas publicadas que copia o site para a
conta do visitante, e false o remove. Deixe de fora para manter a configuração atual.\n
Após invocar esta ferramenta, sua resposta no chat deve ter EXATAMENTE 1 frase resumindo
que o site está sendo publicado e você deve fornecer a URL publicada ao usuário imediatamente.
- Método:
POST - Caminho:
/api/horizons/v1/websites/{websiteId}/publish
horizons_websites_get
Obtenha o link para o usuário abrir o site na interface do Hostinger Horizons.\n
Use esta ferramenta quando o usuário quiser o link para um site existente, ou quando você precisar da
URL do site antes ou depois de editá-lo.\n
is_in_progress é verdadeiro enquanto as alterações estão sendo geradas ou o site está sendo publicado;
aguarde até que seja falso antes de publicar. published_at é quando o site foi publicado pela última vez,
is_template indica se as páginas publicadas mostram o banner "Usar modelo", e
has_ecommerce_store indica se ele tem uma loja online.\n
Os sites podem ser editados com a ferramenta Edit website, ou pelo usuário na interface do Hostinger Horizons
na URL do site fornecida.
- Método:
GET - Caminho:
/api/horizons/v1/websites/{websiteId}
hostinger-hosting-mcp
hosting_import-wordpress-website
Importe um site WordPress de um arquivo para um servidor de hospedagem. Esta ferramenta envia um arquivo do site (zip, tar, tar.gz, etc.) e um dump de banco de dados (arquivo .sql) para implantar um site WordPress completo. O arquivo será extraído no servidor automaticamente. Observação: Este processo pode demorar um pouco para sites maiores. Após a conclusão do upload, os arquivos estão sendo extraídos e o site estará disponível em alguns minutos. As credenciais de upload são geradas e usadas internamente — não chame um endpoint separado de URL de upload nem envie os arquivos você mesmo, esta ferramenta faz isso de ponta a ponta. O nome de usuário será resolvido automaticamente a partir do domínio.
- Método:
custom - Caminho:
custom
hosting_deploy-wordpress-plugin
Implante um plugin WordPress de um diretório para um servidor de hospedagem. Esta ferramenta envia todos os arquivos do plugin e aciona a implantação do plugin. As credenciais de upload são geradas e usadas internamente — não chame um endpoint separado de URL de upload nem envie os arquivos você mesmo, esta ferramenta faz isso de ponta a ponta.
- Método:
custom - Caminho:
custom
hosting_deploy-wordpress-theme
Implante um tema WordPress de um diretório para um servidor de hospedagem. Esta ferramenta envia todos os arquivos do tema e aciona a implantação do tema. O tema enviado pode opcionalmente ser ativado após a implantação. As credenciais de upload são geradas e usadas internamente — não chame um endpoint separado de URL de upload nem envie os arquivos você mesmo, esta ferramenta faz isso de ponta a ponta.
- Método:
custom - Caminho:
custom
hosting_deploy-js-application
Implante uma aplicação JavaScript de um arquivo para um servidor de hospedagem. IMPORTANTE: o arquivo deve conter SOMENTE os arquivos de código-fonte da aplicação, não a saída do build; pule o diretório node_modules; também exclua todos os arquivos correspondentes ao .gitignore se o arquivo de ignore existir. O processo de build será acionado automaticamente no servidor após o upload do arquivo. As credenciais de upload são geradas e usadas internamente — não chame um endpoint separado de URL de upload nem envie o arquivo você mesmo, esta ferramenta faz isso de ponta a ponta. Após a implantação, use a ferramenta hosting_list-js-deployments para verificar o status da implantação e acompanhar o progresso do build.
- Método:
custom - Caminho:
custom
hosting_deploy-static-website
Implante um site estático de um arquivo para um servidor de hospedagem. IMPORTANTE: Esta ferramenta só funciona para sites estáticos sem processo de build. O arquivo deve conter arquivos estáticos pré-construídos (HTML, CSS, JavaScript, imagens, etc.) prontos para serem servidos. Se o site tiver um arquivo package.json ou exigir um comando de build, use hosting_deploy-js-application em vez disso. A ferramenta envia o arquivo para o navegador de arquivos do site via TUS e aciona a implantação; o arquivo é extraído e implantado diretamente sem nenhuma etapa de build. As credenciais de upload são geradas e usadas internamente — não chame um endpoint separado de URL de upload nem envie o arquivo você mesmo, esta ferramenta faz isso de ponta a ponta. O nome de usuário será resolvido automaticamente a partir do domínio.
- Método:
custom - Caminho:
custom
hosting_list-js-deployments
Liste as implantações de aplicações JavaScript para verificar o status delas. Use esta ferramenta quando o cliente perguntar sobre o status da implantação. Esta ferramenta recupera uma lista paginada de implantações de aplicações Node.js para um domínio com filtragem opcional por estados de implantação.
- Método:
custom - Caminho:
custom
hosting_show-js-deployment-logs
Recupere os logs de uma implantação de aplicação JavaScript especificada para fins de depuração em caso de falha.
- Método:
custom - Caminho:
custom
hosting_cache_clear-website
Limpa permanentemente todo o cache do lado do servidor para o site de uma vez. Use quando o conteúdo foi atualizado e precisa ficar visível imediatamente, ou após fazer grandes alterações.
Também purga o cache do CDN do Hostinger quando o CDN está habilitado no site. Para uma instalação WordPress que vive em um subdiretório, passe o parâmetro de consulta do diretório para limpar o cache dele.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/clear
hosting_cache_toggle-cacheless
Ativa ou desativa o modo de desenvolvimento (sem cache), com base no sinalizador enabled. Quando ativado, nada é armazenado em cache, efetivamente desligando todo o cache do site; use enquanto desenvolve ativamente, testa alterações, depura problemas ou quando atualizações em tempo real precisam estar visíveis. Desative após terminar o trabalho de desenvolvimento para restaurar os benefícios de desempenho do cache.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/cacheless-mode/toggle
hosting_cache_toggle-website
Ativa ou desativa o cache do lado do servidor para o site, com base no sinalizador enabled. Ative para carregamentos de página mais rápidos, carga reduzida no servidor e melhor experiência do usuário; recomendado para sites de produção. Desativar pode impactar o desempenho; para contornar temporariamente o cache durante o desenvolvimento ou depuração, prefira alternar o modo sem cache.
Não faz nada se o cache já estiver no estado solicitado.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/cache/toggle
hosting_cron-jobs_list
Retorna a lista de tarefas cron configuradas para a conta especificada, incluindo o agendamento e o comando delas.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/cron-jobs
hosting_cron-jobs_create
Cria uma tarefa cron para a conta especificada a partir de uma expressão de agendamento e um comando.
Retorna a tarefa cron criada, incluindo o uid dela, que é necessário para excluir a tarefa cron ou buscar a saída dela.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/cron-jobs
hosting_cron-jobs_delete
Exclui permanentemente a tarefa cron identificada pelo uid dela.
O uid é retornado pelo endpoint de listar tarefas cron.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/cron-jobs/{uid}
hosting_cron-jobs_output
Retorna a saída capturada da última execução da tarefa cron identificada pelo uid dela.
O uid é retornado pelo endpoint de listar tarefas cron.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/cron-jobs/{uid}/output
hosting_databases_change-password
Altera a senha do usuário de banco de dados especificado.
O nome do banco de dados deve ser o nome completo retornado pelo endpoint de listar bancos de dados. A senha também deve ser atualizada em qualquer configuração do site que use este banco de dados.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/databases/{name}/change-password
hosting_databases_list
Retorna uma lista paginada de bancos de dados para a conta especificada.
Use os filtros de domínio e is_assigned para encontrar bancos de dados atribuídos a um domínio específico.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/databases
hosting_databases_create
Cria um banco de dados com um usuário e senha de banco de dados para a conta especificada.
O nome do banco de dados e o usuário são automaticamente prefixados com o nome de usuário da conta quando necessário.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/databases
hosting_databases_delete
Exclui permanentemente um banco de dados e as conexões remotas dele.
O nome do banco de dados deve ser o nome completo retornado pelo endpoint de listar bancos de dados.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/databases/{name}
hosting_databases_create-remote-connection
Permite que um host remoto se conecte ao banco de dados especificado.
Forneça um endereço IPv4/IPv6, ou "%" para permitir qualquer host. O nome do banco de dados deve ser o nome completo retornado pelo endpoint de listar bancos de dados. A criação do banco de dados é síncrona, então um 404 aqui significa que nenhum banco de dados com esse nome existe sob o nome de usuário, não que ele ainda está sendo criado.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/databases/{name}/remote-connections
hosting_databases_delete-remote-connection
Remove permanentemente uma regra de acesso remoto, revogando o acesso remoto do host informado ao banco de dados.
Identifique a regra com o parâmetro de consulta ip obrigatório (o endereço IPv4/IPv6, ou "%",
exatamente como retornado pelo endpoint de listar conexões remotas). O nome do banco de dados deve ser
o nome completo retornado pelo endpoint de listar bancos de dados.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/databases/{name}/remote-connections
hosting_databases_list-remote-connections
Retorna as regras de acesso remoto para a conta especificada: os hosts remotos (endereços IPv4/IPv6, ou "%" para qualquer host) autorizados a se conectar aos bancos de dados da conta.
Use o filtro de domínio para retornar apenas regras para bancos de dados atribuídos a um domínio específico.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/databases/remote-connections
hosting_databases_repair
Repara tabelas de banco de dados corrompidas de forma assíncrona.
Use quando erros de banco de dados, falhas ou corrupção forem relatados. O nome do banco de dados deve ser o nome completo retornado pelo endpoint de listar bancos de dados.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/databases/{name}/repair
hosting_databases_setup-website
Cria um novo banco de dados MySQL para o site e grava seus detalhes de conexão nas variáveis de ambiente do site e, em seguida, reinicia o aplicativo. A plataforma gera a senha (e o nome do banco de dados e o usuário, a menos que fornecidos). A senha nunca é retornada; o aplicativo a lê do ambiente.
Variáveis gravadas: DB_HOST, DB_PORT, DB_NAME, DB_USER, DB_PASSWORD e
DATABASE_URL (mysql://user:password@host:port/name, usuário e senha codificados em percentual).
As variáveis existentes são mantidas. Se o site já tiver qualquer variável com um desses
nomes, a chamada falha com 422 e nada é criado; o endpoint Replace Node.js environment variables as remove.
Após esta chamada, as variáveis são variáveis de ambiente comuns: o
endpoint Replace Node.js environment variables as altera ou remove como qualquer outra.
Uma reinicialização é suficiente para aplicativos que leem variáveis de ambiente na inicialização do processo, como
Express ou NestJS. Frameworks que incorporam variáveis na saída do build (Next.js,
NEXT_PUBLIC_*) veem os novos valores apenas após um novo build (endpoint Start Node.js build).
Uma senha na solicitação é ignorada; a plataforma sempre a gera. Os opcionais name
e user são identificadores, não segredos.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/databases/setup
hosting_databases_phpmyadmin-link
Retorna um link de login direto para o phpMyAdmin para o banco de dados especificado.
Use quando uma interface visual de banco de dados for necessária para consultas SQL, importações, exportações ou gerenciamento de tabelas. O nome do banco de dados deve ser o nome completo retornado pelo endpoint de listar bancos de dados.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/databases/{name}/phpmyadmin-link
hosting_datacenters_list
Recupere uma lista de datacenters disponíveis para configurar planos de hospedagem com base na capacidade disponível do datacenter e no plano de hospedagem do seu pedido. O primeiro item da lista é a melhor correspondência para os requisitos específicos do seu pedido.
- Método:
GET - Caminho:
/api/hosting/v1/datacenters
hosting_domains_generate-free-subdomain
Gere um subdomínio gratuito exclusivo que pode ser usado para serviços de hospedagem sem comprar domínios personalizados. Os subdomínios gratuitos permitem que você comece a usar os serviços de hospedagem imediatamente e você sempre pode conectar um domínio personalizado ao seu site mais tarde.
- Método:
POST - Caminho:
/api/hosting/v1/domains/free-subdomains
hosting_domains_list-website-parked
Recupere todos os domínios estacionados ou de alias criados no site selecionado.
Use este endpoint para inspecionar a configuração de domínio estacionado para um site específico, incluindo o domínio pai e o diretório raiz atribuídos a cada domínio estacionado.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains
hosting_domains_create-website-parked
Crie um domínio estacionado ou de alias para o site selecionado.
Forneça um nome de domínio ou endereço IP para estacionar no site para que ele sirva o mesmo conteúdo que o domínio pai.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains
hosting_domains_delete-website-parked
Exclua um domínio estacionado ou de alias existente do site selecionado.
Use este endpoint para remover domínios estacionados que não são mais necessários.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/parked-domains/{parkedDomain}
hosting_domains_list-website-subdomains
Recupere todos os subdomínios criados no site selecionado.
Use este endpoint para inspecionar a configuração de subdomínio para um site específico, incluindo o domínio pai e o diretório raiz atribuídos a cada subdomínio.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains
hosting_domains_create-website-subdomain
Crie um novo subdomínio para o site selecionado.
Forneça um prefixo de subdomínio e, opcionalmente, um diretório personalizado ou o diretório público do site para usar como raiz do subdomínio.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains
hosting_domains_delete-website-subdomain
Exclua um subdomínio existente do site selecionado.
Use este endpoint para remover subdomínios que não são mais necessários.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/subdomains/{subdomain}
hosting_domains_verify-ownership
Verifique a propriedade de um único domínio e retorne o status da verificação.
Use este endpoint para verificar se um domínio está acessível para você antes de usá-lo para novos sites.
Se o domínio estiver acessível, a resposta terá is_accessible: true.
Se não, adicione o registro TXT fornecido aos registros DNS do seu domínio e tente verificar novamente.
Lembre-se de que pode levar até 10 minutos para que novos registros DNS TXT sejam propagados.
Ignore esta verificação ao usar os subdomínios gratuitos da Hostinger (*.hostingersite.com).
- Método:
POST - Caminho:
/api/hosting/v1/domains/verify-ownership
hosting_files_generate-upload-url
Gere uma URL de upload do navegador de arquivos com credenciais de autenticação para enviar arquivos diretamente para o armazenamento de arquivos de um site.
Enquanto o site ainda está sendo configurado (status: running no endpoint de listar configurações de site),
este endpoint retorna 409 com um cabeçalho Retry-After: aguarde esse número
de segundos e tente novamente, ou consulte as configurações do site até que o status seja completed.
Retorna url, auth_key e rest_auth_key. Use-os para enviar um arquivo para o
diretório public_html do site via protocolo de upload retomável TUS (TUS 1.0.0).
Envie os cabeçalhos X-Auth: {auth_key} e X-Auth-Rest: {rest_auth_key} em cada solicitação
abaixo.
- Crie o upload:
POSTpara{url}/{relative_file_path}?override=truecom os cabeçalhosupload-length: {file size in bytes}eupload-offset: 0. Espere201 Created. - Envie o arquivo: envie os bytes do arquivo para o mesmo local (qualquer cliente TUS 1.0.0, ou
solicitações
PATCHcom um cabeçalhoupload-offsetrastreando o progresso) até a conclusão.
relative_file_path é o caminho de destino dentro de public_html, por exemplo, app.zip.
Em vez de um cliente TUS, curl simples também funciona:
FILE=app.zip
SIZE=$(stat -f%z "$FILE") # stat -c%s on Linux
curl -i -X POST "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Upload-Length: ${SIZE}" \
-H "Upload-Offset: 0"
# -> 201 Created
curl -i -X PATCH "{url}/${FILE}?override=true" \
-H "X-Auth: {auth_key}" \
-H "X-Auth-Rest: {rest_auth_key}" \
-H "Tus-Resumable: 1.0.0" \
-H "Content-Type: application/offset+octet-stream" \
-H "Upload-Offset: 0" \
--data-binary "@${FILE}"
# -> 204 No Content, Upload-Offset response header equals SIZE when done
- Método:
POST - Caminho:
/api/hosting/v1/files/upload-urls
hosting_files_list-website-and-directories
Liste arquivos e diretórios sob a raiz de documentos de um site.
Use directory para navegar em um subdiretório relativo à raiz de documentos. Entradas de links simbólicos
são listadas, mas nunca percorridas ou resolvidas.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/domains/{domain}/files
hosting_files_website-content
Obtenha o conteúdo de um único arquivo, relativo à raiz de documentos de um site.
Somente leitura; recusa links simbólicos, arquivos muito grandes, tipos de arquivo não textuais e arquivos identificados como contendo segredos (por exemplo, arquivos de credenciais) — nenhum deles é retornado por este endpoint.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/domains/{domain}/files/content
hosting_git_auto-deployment-settings
Retorna as configurações de implantação automática do Git do site: qual repositório e branch implantam
em qual diretório e se pushes acionam uma implantação. is_enabled false mantém o
link do repositório, mas ignora pushes.
Quando o site não tem implantação automática configurada, todos os campos são nulos. Salve as configurações com
Update Git auto-deployment settings.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings
hosting_git_update-auto-deployment-settings
Cria ou substitui as configurações de implantação automática do Git do site: repositório, branch, o
diretório sob a raiz de documentos para implantar e is_enabled. Envie o conjunto completo;
is_enabled assume o padrão true e directory para a raiz de documentos. installation_uuid deve
ser uma instalação de List Git installations que pertence ao mesmo cliente que o
site.
Para sites PHP e estáticos, salvar com is_enabled true implanta o branch imediatamente e cada
push posterior para esse branch implanta novamente. Para sites Node.js e Website Builder, salvar
não clona nada. Em um site Node.js, inicie a primeira implantação com
Start Node.js build usando source_type git; pushes então acionam novos builds com as configurações de build
armazenadas para o site.
- Método:
PUT - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings
hosting_git_delete-auto-deployment-settings
Remove as configurações de implantação automática do Git do site. Os arquivos já implantados permanecem no site; pushes param de implantar até que as configurações sejam salvas novamente. Também é bem-sucedido quando nada está configurado.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings
hosting_git_list-installations
Lista as contas do provedor Git que o cliente conectou. Somente instalações com status
active são retornadas, a menos que o filtro status diga o contrário.
Uma lista vazia significa que o cliente não tem instalação ativa. Verifique também status=suspended e
status=pending. Se não houver nenhuma, um provedor Git (GitHub ou GitLab) deve ser
conectado uma vez no hPanel (Websites, Manage, Advanced, Git; ou Add Website, Node.js Web App,
Import Git Repository); este endpoint então lista a nova instalação.
Use uuid como o parâmetro de caminho de List Git installation repositories, e como
installation_uuid em Start Node.js build com source_type git e em
Update Git auto-deployment settings.
- Método:
GET - Caminho:
/api/hosting/v1/git/installations
hosting_git_list-installation-repositories
Lista os repositórios que a instalação do Git pode acessar, lidos ao vivo do provedor. Funciona para instalações github e gitlab. Use uma instalação ativa: uma suspensa ou pendente ainda é consultada e a chamada falha com o que o provedor responder. A lista é cortada nos primeiros 500 repositórios na ordem em que o provedor os retorna; quando a conta tem mais, nomeie o repositório diretamente em vez de pesquisar nesta lista.
owner, name e um branch (default_branch ou outro) vão para source_options de
Start Node.js build ou para Update Git auto-deployment settings. Retorna 404 quando a
instalação não pertence ao cliente. Limitado a 10 chamadas por minuto por cliente de API
(429 acima disso).
- Método:
GET - Caminho:
/api/hosting/v1/git/installations/{uuid}/repositories
hosting_git_deploy-website-repository
Clona um repositório Git em um diretório do site, ou o puxa novamente. Um diretório vazio ou ausente
recebe um clone do branch. Um diretório que já contém este repositório e branch é
redefinido para seu último commit e puxado: alterações feitas no servidor em arquivos que o repositório rastreia são
descartadas, arquivos que ele não rastreia permanecem. Um diretório que contém outros arquivos, incluindo outro
repositório ou outro branch deste, é rejeitado. composer install é executado após o clone ou
pull quando o repositório tem um composer.json.
A chamada aguarda a implantação e retorna seu log. is_success false significa que Git ou composer
falhou e o log diz o porquê. Uma segunda chamada para o mesmo diretório é rejeitada enquanto a primeira ainda
está aguardando o servidor. Se a solicitação expirar, a implantação pode ainda terminar no
servidor; chamar novamente mais tarde com o mesmo repositório e branch puxa.
Repositórios privados precisam de uma URL SSH e da chave SSH Git da conta em Generate Git SSH key,
adicionada ao repositório como uma chave de deploy.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/repositories/deploy
hosting_git_list-website-repositories
Lista os repositórios Git vinculados aos diretórios do site, com
Deploy website Git repository ou na seção Git do hPanel: URL de clone, branch e diretório de
cada um. Um repositório cujo clone falhou permanece listado; implantá-lo novamente tenta o clone outra vez. Auto-implantações do GitHub
e do GitLab não são listadas aqui; veja Get Git auto-deployment settings.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/git/repositories
hosting_git_ssh-public-key
Retorna a chave SSH pública da conta de hospedagem. Deploy website Git repository usa esta chave para
clonar e puxar via SSH, então um repositório privado funciona assim que a chave é adicionada a ele como uma chave de deploy
no host Git. public_key é nulo quando a conta ainda não tem chave.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/git/ssh-key
hosting_git_generate-ssh-key
Cria o par de chaves SSH da conta de hospedagem e retorna a chave pública. Quando a conta já tem uma chave, retorna essa chave inalterada. Uma chave atende a todos os sites da conta; adicione a chave pública a um repositório privado como uma chave de deploy antes de implantá-lo.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/git/ssh-key
hosting_headless_submit-build-report
Envia o relatório de build que a skill headless escreve ao final de uma execução (incluindo paradas antecipadas), para que a Hostinger possa aprender onde os builds ficam travados. Envie um relatório por chamada, com o JSON do relatório como corpo da requisição, inalterado. Envie um relatório apenas quando o usuário concordou com isso.
O relatório deve corresponder ao report.schema.json v1; um relatório inválido retorna 422 e não é armazenado. O relatório é vinculado à conta autenticada, então não adicione detalhes da conta a ele.
- Método:
POST - Caminho:
/api/hosting/v1/headless/agent-reports
hosting_nodejs_list-builds
Recupera uma lista paginada de processos de build Node.js para um site específico.
Cada build representa uma única execução do pipeline de build Node.js. Use o parâmetro de consulta states
para filtrar os resultados por estado do build (pendente, em execução, concluído, falhou).
Use o uuid de um build para consultar sua saída via o endpoint Get Node.js Build Logs.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds
hosting_nodejs_start-build
Inicia um processo de build Node.js usando arquivos já presentes no armazenamento de arquivos do site.
AVISO: em caso de sucesso, isso sobrescreve o conteúdo existente do site e não pode ser desfeito — verifique se isso é intencional antes de chamar este endpoint.
Com source_type archive, source_options.archive_path deve apontar para um arquivo
de arquivo existente no servidor (relativo à raiz do documento do site). Use o
endpoint Generate Upload URL para obter credenciais e enviar o arquivo primeiro. Para
detectar automaticamente as configurações de build de um arquivo antes de iniciar, primeiro chame o
endpoint Get Node.js Build Settings from Archive.
Com source_type git, source_options carrega owner, repository, branch e
installation_uuid. Pegue a instalação de List Git installations e o proprietário e
repositório de List Git installation repositories; o branch é clonado em seu
head atual. A instalação deve pertencer ao mesmo cliente que o site.
O uuid do build retornado pode ser usado para consultar o progresso e recuperar logs via
o endpoint Get Node.js Build Logs.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds
hosting_nodejs_build-settings
Retorna as configurações de build armazenadas para o site: framework (app_type), versão do Node.js,
diretório raiz e de saída, script de build, arquivo de entrada e gerenciador de pacotes. As configurações armazenadas
direcionam os builds de auto-implantação Git. Um build iniciado pela API usa os valores enviados em
essa requisição e os salva aqui apenas quando nenhuma configuração existe ainda.
Retorna 404 até que o primeiro build ou a primeira atualização de configurações os armazene. Use isso após
um build falho para verificar se o framework ou o arquivo de entrada foram detectados incorretamente, depois
corrija-os com o endpoint Update Node.js build settings.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings
hosting_nodejs_update-build-settings
Substitui as configurações de build armazenadas para o site. Envie o conjunto completo: node_version é
obrigatório e todo campo anulável que você omitir é armazenado como nulo. Cria as configurações quando
nenhuma existe ainda.
Isso não inicia um build. As configurações armazenadas direcionam os builds de auto-implantação Git; um build
iniciado pela API usa os valores enviados nessa requisição, então para reconstruir com configurações corrigidas
chame Start Node.js build com os mesmos valores. Correções típicas: um app_type errado
após a detecção automática, ou um entry_file ausente para aplicativos express, fastify, nest, nuxt e hono.
- Método:
PUT - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings
hosting_nodejs_build-settings-from-archive
Detecta automaticamente as configurações de build Node.js de um package.json dentro de um arquivo já no servidor.
Use isso antes de chamar Start Node.js Build para pré-visualizar quais configurações serão usadas,
ou para permitir que o usuário revise e substitua valores (framework, versão do node, diretório raiz,
diretório de saída, script de build) antes de se comprometer com um build.
O arquivo já deve estar presente no armazenamento de arquivos do site. Use o
endpoint Generate Upload URL para obter credenciais e enviar o arquivo primeiro.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/from-archive
hosting_nodejs_list-environment-variables
Lista as variáveis de ambiente Node.js atualmente definidas para o site. Os valores são sempre
mascarados como ******** e não podem ser lidos de volta através desta API. Use este endpoint para ver
quais chaves estão configuradas ou para verificar uma alteração, não para ler valores.
Para alterar variáveis, use o endpoint Replace Node.js environment variables. Ele substitui
o conjunto inteiro, então nunca copie os valores mascarados desta resposta para essa requisição; envie
o conjunto completo desejado com valores reais retirados do arquivo .env do projeto ou do prompt do usuário.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/env
hosting_nodejs_replace-environment-variables
Substitui as variáveis de ambiente Node.js do site pelas fornecidas. Isso é uma
substituição completa: qualquer variável não presente na requisição é excluída, e enviar um array env_vars
vazio exclui todas as variáveis. Salvar grava os valores e reinicia o processo Node.js
em execução.
Uma reinicialização é suficiente para aplicativos que leem variáveis de ambiente na inicialização do processo, como
Express ou NestJS. Não é suficiente para frameworks que incorporam variáveis no build.
Next.js standalone é um deles: valores em tempo de build (incluindo NEXT_PUBLIC_*) precisam de um
novo build. Após esta chamada, use o endpoint Start Node.js build para que esses aplicativos
captem os novos valores.
O endpoint List Node.js environment variables retorna valores mascarados (********), então
nunca copie valores dele para esta requisição. Sempre envie o conjunto completo desejado com valores
reais retirados do arquivo .env do projeto ou do prompt do usuário.
- Método:
PUT - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/settings/env
hosting_nodejs_analyse-failed-build
Retorna uma análise de IA sobre por que um build falhou e como corrigi-lo, com base nos logs do build,
na lista de arquivos do projeto e no package.json. Apenas builds no estado failed podem ser analisados;
qualquer outro estado retorna 422. Quando nenhuma análise pôde ser produzida, tanto analysis quanto
solution são nulos; nesse caso, leia Get NodeJS build logs.
Cada chamada executa a análise novamente, então chame uma vez por build falho e mantenha o resultado. Limitado a 5 chamadas por minuto por cliente de API (429 acima disso).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/{uuid}/analysis
hosting_nodejs_build
Retorna um build por UUID: seu estado (pending, running, completed, failed), as
opções com que foi executado e carimbos de data/hora. Consulte enquanto um build está pendente ou em execução. Quando
está falho, leia Get NodeJS build logs e Analyse failed Node.js build para a causa.
Retorna 404 quando o UUID não pertence a um build deste site.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/{uuid}
hosting_nodejs_build-logs
Recupera logs de um processo de build Node.js específico.
Para transmitir saída ao vivo enquanto um build está em execução, consulte este endpoint repetidamente
enquanto o estado do build for running, passando a contagem lines retornada anteriormente
como from_line para buscar apenas nova saída desde a última chamada.
O conteúdo do log pode conter sequências de escape ANSI (códigos de cor).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/builds/{uuid}/logs
hosting_nodejs_runtime-logs
Retorna as entradas de log de console em tempo de execução do aplicativo Node.js, mais antigas primeiro, cada uma com
carimbo de data/hora, nível e mensagem. Na primeira chamada, envie period (1h, 1d, 1w ou 1m)
e opcionalmente levels e limit (1-5000, padrão 1000); quando mais entradas correspondem do que
limit, as mais recentes são mantidas.
Para consultar novas entradas, envie total_lines + 1 da resposta anterior como from_line
e omita period; period e from_line não podem ser combinados. Linhas que não são JSON
com um carimbo de data/hora, nível e mensagem são ignoradas, então logs pode conter menos do que limit
entradas enquanto total_lines conta cada linha bruta. Entradas com um carimbo de data/hora antes de
last_deployed_at pertencem à implantação anterior. Retorna uma lista logs vazia quando
o aplicativo ainda não escreveu um arquivo de log.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/runtime-logs
hosting_nodejs_clear-runtime-logs
Esvazia o arquivo de log em tempo de execução do aplicativo Node.js. Isso não pode ser desfeito, então confirme com o usuário antes de chamá-lo. Retorna sucesso mesmo quando nenhum arquivo de log existe ainda.
Use-o antes de reproduzir um problema para que a próxima chamada Get Node.js runtime logs retorne
apenas entradas novas; inicie essa chamada com period novamente em vez de reutilizar um from_line
de antes da limpeza.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/runtime-logs
hosting_nodejs_restart-application
Reinicia o processo do servidor Node.js para o site. Não reconstrói nem reimplanta o aplicativo. Use-o para aplicar alterações de ambiente ou configuração, ou para recuperar um aplicativo travado.
Aplicável apenas a aplicativos do lado do servidor (Express, Next.js, NestJS, etc.). Aplicativos front-end estáticos (React, Vue, Vite) não têm processo de servidor persistente, então reiniciá-los não tem efeito. Retorna sucesso mesmo quando o site não tem processo de servidor para reiniciar.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/server/restart
hosting_nodejs_list-vulnerabilities
Lista vulnerabilidades conhecidas de pacotes npm detectadas em um site Node.js, enriquecidas com
metadados de aviso (gravidade, pontuação CVSS, CVE, URL do aviso). Os resultados são classificados do
mais grave ao menos grave, depois por data de publicação (mais recente primeiro). Use o
parâmetro de consulta severities para filtrar.
Vulnerabilidades com is_patchable definido como true podem ser corrigidas automaticamente via o
endpoint Patch Node.js Vulnerabilities, que abre uma pull request no GitHub com
versões atualizadas de pacotes. A correção automática está disponível apenas para sites implantados de um
repositório GitHub conectado. Vulnerabilidades com is_patching_in_progress definido como
true já estão incluídas em uma pull request de correção aberta; enquanto qualquer pull request de correção
estiver aberta, novas solicitações de correção para este site são rejeitadas até que ela seja mesclada
ou fechada.
Os dados vêm de varreduras periódicas de dependências, então podem ficar desatualizados em relação à implantação mais recente. Uma lista vazia significa que a varredura mais recente não encontrou vulnerabilidades; isso não garante que a implantação atual esteja livre de vulnerabilidades. Disponível nos planos Business e Cloud Hosting.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities
hosting_nodejs_patch-vulnerabilities
Corrige as vulnerabilidades selecionadas do Node.js atualizando as versões dos pacotes afetados
em package.json e abrindo um pull request no GitHub no repositório conectado. O
cliente revisa e mescla o pull request; a mesclagem aciona a implantação automática.
A correção automática está disponível apenas para sites implantados a partir de um repositório GitHub conectado. Sites implantados a partir de um arquivo não têm caminho de correção automática e retornam 404. O aplicativo GitHub da Hostinger precisa de acesso de escrita ao repositório; sem isso, a solicitação falha com um 403 explicando a permissão ausente.
Apenas vulnerabilidades com is_patchable definido como true podem ser corrigidas. IDs não corrigíveis
na seleção são ignorados; o pull request cobre o subconjunto corrigível, listado
em patched_vulnerability_ids. Seleções sem qualquer vulnerabilidade corrigível são
rejeitadas com um 422. Apenas um pull request de correção pode estar aberto por vez por site;
feche ou mescle-o antes de corrigir novamente. Disponível nos planos Business e Cloud Hosting.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/nodejs/vulnerabilities/patch
hosting_websites_list-setups
Retorna as configurações de site iniciadas nas últimas 24 horas para as contas de hospedagem
acessíveis ao cliente autenticado, das mais recentes para as mais antigas. Restrinja a lista com os
filtros order_id, subscription_id ou domain.
Destinado à consulta logo após criar um site ou iniciar uma configuração de site: o
site aparece na lista de sites antes que a configuração do lado do servidor termine, e
enquanto a configuração está running, endpoints que operam nesse site podem responder com
404 ou 409. Consulte este endpoint com o filtro domain a cada 10 a 15 segundos e
aguarde status: completed antes de enviar arquivos, implantar ou criar bancos de dados.
failed significa que a configuração parou antes de terminar ou não relatou progresso por
mais de uma hora. Configurações com mais de 24 horas não são listadas.
type é o tipo de site com o qual a configuração foi iniciada (wordpress, headless_wordpress,
headless_ecommerce, headless_pocketbase) ou null para um site vazio.
- Método:
GET - Caminho:
/api/hosting/v1/onboardings
hosting_websites_start-setup
Inicia uma configuração de site em um pedido de hospedagem Web ou Cloud e retorna a configuração criada
imediatamente; o site em si é provisionado de forma assíncrona. Consulte o endpoint de listagem de
configurações de site com o filtro domain a cada 10 a 15 segundos e aguarde
status: completed antes de enviar arquivos, implantar ou criar bancos de dados.
Omita type para um site vazio. type: wordpress instala o WordPress na raiz
do site com o usuário administrador, e-mail e senha de wordpress, o domínio como título
do site e en_US quando wordpress.language for omitido. Os tipos headless
(headless_wordpress, headless_ecommerce, headless_pocketbase) criam um site
headless; headless_wordpress adicionalmente instala o WordPress no diretório cms
da raiz do site com credenciais geradas.
Omita domain para configurar o site em um subdomínio gratuito temporário gerado.
Quando o pedido ainda não tem uma conta de hospedagem, a configuração cria uma primeiro, no datacenter
fornecido por datacenter_code ou no datacenter padrão do pedido quando for omitido.
Retorna 404 quando o pedido não existe ou não é acessível ao cliente
autenticado, e 409 com um cabeçalho Retry-After enquanto uma configuração para o mesmo domínio ainda estiver
em execução.
- Método:
POST - Caminho:
/api/hosting/v1/orders/{order_id}/onboardings
hosting_orders_list
Recupera uma lista paginada de pedidos acessíveis ao cliente autenticado.
Apenas pedidos de hospedagem Web e Cloud são listados. Pedidos do plano Agency são listados por
GET /api/agency-hosting/v1/orders.
Este endpoint retorna pedidos das suas contas de hospedagem, bem como pedidos de outras contas de hospedagem de clientes que compartilharam acesso com você.
Use os parâmetros de consulta disponíveis para filtrar resultados por status de pedido ou IDs de pedido específicos para resultados mais direcionados.
- Método:
GET - Caminho:
/api/hosting/v1/orders
hosting_php_reset-extensions
Redefine todas as extensões PHP do site para o estado padrão.
Use para se recuperar de conflitos de extensão ou restaurar a configuração original.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/extensions/reset
hosting_php_get
Retorna a configuração completa do PHP para o site: versão atual, versões disponíveis
(suportadas e não suportadas), extensões habilitadas/desabilitadas, opções com seu valor atual,
padrão, tipo e o limite do plano (max), e grupos de extensões conflitantes.
Use para verificar a configuração atual do PHP antes de atualizar a versão, extensões ou opções.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/details
hosting_php_info
Retorna a página phpinfo completa (HTML) para o site.
Use para depurar problemas de PHP ou inspecionar o ambiente PHP completo do site.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/php-info
hosting_php_update-extensions
Habilita ou desabilita extensões PHP (módulos) para o site.
Use o endpoint Obter detalhes do PHP para verificar os estados atuais das extensões antes de alterá-los.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/extensions
hosting_php_update-options
Atualiza opções do PHP para o site (ex.: memory_limit, max_execution_time, upload_max_filesize).
Forneça apenas as opções que deseja alterar, dentro do objeto options.
Valores acima do limite do plano da conta são silenciosamente limitados a esse limite, então a solicitação pode ser bem-sucedida com um valor aplicado menor. Chame o endpoint Obter detalhes do PHP depois para ler o valor aplicado.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/options
hosting_php_update-version
Altera a versão do PHP do site.
Use o endpoint Obter detalhes do PHP para ver as versões disponíveis para o site.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/php/version
hosting_redirects_list-website
Retorna uma lista paginada de redirecionamentos configurados para o site selecionado.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_redirects_create-website
Cria um redirecionamento de uma URL no site selecionado para outra URL ou endereço IP.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_redirects_delete-website
Exclui permanentemente o redirecionamento identificado pela sua URL de origem.
Passe o valor from exatamente como retornado pelo endpoint de listagem de redirecionamentos.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/redirects
hosting_ssl_install
Solicita um certificado SSL vitalício para o site. A instalação é executada em segundo plano;
Get SSL status relata active ou failed quando termina. Um certificado vitalício active
não bloqueia a solicitação: uma nova instalação é solicitada, que é como um certificado é
reinstalado.
Retorna 422 para subdomínios gratuitos (seu certificado é gerenciado pela plataforma), enquanto uma
instalação está installing ou waiting_for_retry, quando o certificado do site foi
revogado (não pode ser reemitido) e quando um certificado personalizado enviado está instalado; esse
precisa ser desinstalado primeiro.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/setup
hosting_ssl_status
Retorna o estado SSL do site: o certificado status e provider, se o
certificado é vitalício e gerenciado pela plataforma, se solicitações HTTP são redirecionadas para
HTTPS, quando o certificado deixa de ser válido e o último erro de instalação.
installing e waiting_for_retry significam que uma instalação está em andamento. failed significa que a
última instalação desistiu, ou o site não foi atualizado por 60 minutos enquanto installing;
last_error contém o motivo quando é uma mensagem conhecida, caso contrário é nulo. expired
significa que a validade do certificado atribuído terminou. not_installed significa que nenhum certificado está
atribuído. Subdomínios gratuitos usam um certificado gerenciado pela plataforma: sem instalação registrada,
eles relatam active com provider e expires_at nulos.
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/status
hosting_ssl_toggle-https-redirect
Ativa ou desativa o redirecionamento de HTTP para HTTPS do site, com base em is_enabled. Não faz
nada quando o redirecionamento já está no estado solicitado. Ativá-lo requer um certificado
instalado (status active ou expired em Get SSL status) e retorna 422
quando não há nenhum; desativá-lo é sempre aceito.
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl/https-redirect/toggle
hosting_ssl_uninstall
Remove o certificado SSL atribuído ao site, desativa o redirecionamento HTTPS e cancela
uma nova tentativa de instalação pendente. O site serve HTTP simples até que uma nova instalação
seja concluída. Get SSL status relata not_installed assim que a chamada retorna; a chamada também
é bem-sucedida quando nenhum certificado está atribuído, então repeti-la é seguro.
Retorna 422 para subdomínios gratuitos (seu certificado é gerenciado pela plataforma) e enquanto uma
instalação está installing.
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/ssl
hosting_websites_list
Recupera uma lista paginada de sites (CloudLinux, Builder e Horizons) acessíveis ao cliente autenticado.
Este endpoint retorna sites das suas contas de hospedagem, bem como sites de outras contas de hospedagem de clientes que compartilharam acesso com você.
Cada site inclui um campo website_type descrevendo o tipo de
site detectado na plataforma subjacente (wordpress, builder,
horizons, nodejs ou other). Alguns campos, como
vhost_type, username e root_directory, aplicam-se apenas a
sites CloudLinux e são nulos para outras plataformas.
Use website_types para listar apenas sites de um determinado tipo detectado, ex.: apenas
sites WordPress (website_types=wordpress) ou apenas sites Node.js
(website_types=nodejs). Combine com os outros parâmetros de consulta disponíveis para
filtrar por nome de usuário, ID do pedido, status de habilitação ou nome de domínio para resultados mais
direcionados.
Um site aparece nesta lista antes que a configuração do lado do servidor termine, e
is_enabled reflete suspensão, não prontidão. Para saber quando um site recém-criado
está pronto para operações de arquivo, implantação ou banco de dados, consulte o endpoint de listagem
de configurações de site.
- Método:
GET - Caminho:
/api/hosting/v1/websites
hosting_websites_create
Obsoleto: use POST /api/hosting/v1/orders/{order_id}/onboardings (iniciar configuração de site)
em vez disso. Ele aceita os mesmos domain e datacenter_code, também pode instalar WordPress e
retorna a configuração criada.
Crie um novo site para o cliente autenticado.
Você deve escolher em qual pedido de hospedagem criar este site. Passe esse
pedido como order_id junto com o nome de domínio. Liste os pedidos para ver
os IDs disponíveis; o site é provisionado no plano de hospedagem desse pedido.
Apenas pedidos de hospedagem Web e Cloud são aceitos. Para criar um site em um pedido
do plano Agency, use POST /api/agency-hosting/v1/orders/{order_id}/websites/setups.
Quando o pedido ainda não tem uma conta de hospedagem, uma nova conta de hospedagem é configurada primeiro, no
datacenter fornecido por datacenter_code ou no datacenter padrão do pedido quando for omitido.
Sites subsequentes serão hospedados no mesmo datacenter automaticamente.
A criação do site é assíncrona e leva até alguns minutos. Consulte o endpoint de listagem de
configurações de site com o filtro domain a cada 10 a 15 segundos e aguarde status: completed antes de enviar arquivos, implantar ou criar bancos de dados. Enquanto a configuração está
running, endpoints que operam no site podem responder com 404 ou 409.
is_enabled na lista de sites reflete suspensão, não prontidão.
- Método:
POST - Caminho:
/api/hosting/v1/websites
hosting_websites_deploy-static-site-archive
Implemente um aplicativo estático a partir de um arquivo de arquivo.
AVISO: isso substitui o conteúdo existente do site e não pode ser desfeito — verifique se isso é intencional antes de chamar este endpoint.
Este endpoint permite que você implemente um aplicativo estático a partir de um arquivo que foi enviado para o diretório do site.
Isso funciona apenas para sites estáticos (HTML/CSS/JS pré-compilados sem etapa de build). Para
aplicativos Node.js, use Create NodeJS build from archive em vez disso, ou
Start Node.js build se o arquivo já estiver enviado. Para sites WordPress,
use Import WordPress website.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/deploy
hosting_websites_delete
Este endpoint remove permanentemente um site e todos os seus dados. Esta ação não pode ser desfeita. Antes de chamá-lo, certifique-se de que o usuário entenda as consequências e confirme explicitamente que deseja prosseguir.
Todos os arquivos do site, bancos de dados e configurações relacionadas serão removidos. O plano de hospedagem em si é mantido, para que um novo site possa ser criado nele posteriormente.
Sites suportados: sites de domínio principal e addon em planos de hospedagem web, e sites do Website Builder. Domínios estacionados e subdomínios não podem ser excluídos com este endpoint. O domínio deve ser o domínio exato do site, não um domínio de visualização ou um alias.
Retorna 404 quando o domínio não existe ou não pertence ao cliente autenticado.
A remoção do site é processada de forma assíncrona e pode levar alguns minutos para concluir. A resposta retorna antes que a remoção termine.
- Método:
DELETE - Caminho:
/api/hosting/v1/websites/{domain}
hostinger-mail-mcp
mail_aliases_create-alias
Crie um alias para a caixa de correio fornecida. O endereço do alias é formado a partir da parte local fornecida e do domínio da caixa de correio. Mensagens enviadas para o alias são entregues à caixa de correio.
- Método:
POST - Caminho:
/api/mail/v1/mailboxes/{mailboxId}/aliases
mail_aliases_delete-alias
Exclua um alias. Mensagens enviadas para o endereço do alias não são mais entregues à caixa de correio.
- Método:
DELETE - Caminho:
/api/mail/v1/aliases/{aliasId}
mail_aliases_list
Recupere uma lista paginada de aliases em todas as caixas de correio de um pedido de e-mail.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/aliases
mail_api-tokens_create
Crie um token de API para o pedido de e-mail fornecido. O token concede acesso à API de E-mail da Hostinger, onde você pode provisionar e gerenciar as caixas de correio às quais ele está vinculado.
O token em texto simples é retornado apenas nesta resposta, nunca novamente.
Um máximo de 10 tokens pode existir por pedido. Use
scope.has_all_mailboxes para cobrir todas as caixas de correio atuais e futuras,
ou liste caixas de correio específicas em scope.mailbox_ids.
- Método:
POST - Caminho:
/api/mail/v1/orders/{orderId}/api-tokens
mail_api-tokens_revoke
Revogue um token de API. O token perde imediatamente o acesso à API de E-mail da Hostinger. Esta ação não pode ser desfeita.
- Método:
DELETE - Caminho:
/api/mail/v1/api-tokens/{tokenId}
mail_api-tokens_list
Recupere uma lista paginada de API de E-mail da Hostinger tokens em todos os seus pedidos de e-mail, opcionalmente filtrados por pedido. Tokens em texto simples nunca são incluídos; eles são retornados apenas quando um token é criado.
- Método:
GET - Caminho:
/api/mail/v1/api-tokens
mail_autoreplies_create
Crie uma resposta automática para a caixa de correio fornecida. Uma caixa de correio pode ter
apenas uma resposta automática. Omita starts_at para ativar a resposta automática
imediatamente e omita ends_at para mantê-la ativa indefinidamente.
- Método:
POST - Caminho:
/api/mail/v1/mailboxes/{mailboxId}/autoreplies
mail_autoreplies_update
Substitua a resposta automática pelo conteúdo e agendamento fornecidos. Campos
opcionais omitidos são limpos: omita starts_at para ativar a
resposta automática imediatamente e omita ends_at para mantê-la ativa
indefinidamente.
- Método:
PUT - Caminho:
/api/mail/v1/autoreplies/{autoreplyId}
mail_autoreplies_delete
Exclua a resposta automática de uma caixa de correio. A caixa de correio para de enviar respostas automáticas imediatamente.
- Método:
DELETE - Caminho:
/api/mail/v1/autoreplies/{autoreplyId}
mail_autoreplies_list
Recupere uma lista paginada de respostas automáticas em todas as caixas de correio de um pedido de e-mail.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/autoreplies
mail_catchalls_create-catch-all
Crie um catch-all que roteia todas as mensagens enviadas para endereços desconhecidos do domínio para a caixa de correio fornecida. O endereço da caixa de correio recebe um e-mail de confirmação e o catch-all se torna ativo somente após ser confirmado. Um domínio pode ter apenas um catch-all.
- Método:
POST - Caminho:
/api/mail/v1/mailboxes/{mailboxId}/catchalls
mail_catchalls_delete-catch-all
Exclua um catch-all. Mensagens enviadas para endereços desconhecidos do domínio não são mais roteadas para a caixa de correio.
- Método:
DELETE - Caminho:
/api/mail/v1/catchalls/{catchallId}
mail_catchalls_list-catch-alls
Recupere uma lista paginada de catch-alls em todas as caixas de correio de um pedido de e-mail.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/catchalls
mail_catchalls_resend-catch-all-confirmation
Reenvie o e-mail de confirmação para o endereço da caixa de correio de um catch-all não confirmado.
- Método:
POST - Caminho:
/api/mail/v1/catchalls/{catchallId}/confirmation/resend
mail_forwarders_create
Crie um encaminhador da caixa de correio fornecida para o endereço de destino. O destino recebe um e-mail de confirmação e o encaminhamento se torna ativo somente após ser confirmado.
- Método:
POST - Caminho:
/api/mail/v1/mailboxes/{mailboxId}/forwarders
mail_forwarders_delete
Exclua um encaminhador. A caixa de correio para de encaminhar mensagens para o endereço de destino imediatamente.
- Método:
DELETE - Caminho:
/api/mail/v1/forwarders/{forwarderId}
mail_forwarders_list
Recupere uma lista paginada de encaminhadores em todas as caixas de correio de um pedido de e-mail.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/forwarders
mail_forwarders_resend-confirmation
Reenvie o e-mail de confirmação para o endereço de destino de um encaminhador não confirmado.
- Método:
POST - Caminho:
/api/mail/v1/forwarders/{forwarderId}/confirmation/resend
mail_forwarders_update-keep-copy-setting
Ative ou desative a manutenção de uma cópia das mensagens encaminhadas na caixa de correio.
- Método:
PATCH - Caminho:
/api/mail/v1/forwarders/{forwarderId}/keep-copy
mail_logs_list-access
Recupere logs de acesso paginados para o domínio anexado ao pedido de e-mail fornecido. Suporta filtragem por conta, intervalo de datas, protocolo, status e sinalizador de exclusão. Os resultados são classificados por timestamp em ordem decrescente.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/logs/access
mail_logs_list-action
Recupere logs de ações de conta paginados (ações administrativas e de usuário) para o pedido de e-mail fornecido. Suporta filtragem por conta, intervalo de datas e status. Os resultados são classificados por timestamp em ordem decrescente.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/logs/action
mail_logs_list-inbound
Recupere logs de entrega de entrada (e-mail recebido) paginados para o domínio anexado ao pedido de e-mail fornecido. Suporta filtragem por conta, intervalo de datas, status, remetente e destinatário. Os resultados são classificados por timestamp em ordem decrescente.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/logs/inbound
mail_logs_list-mailbox-action
Recupere logs de ações de caixa de correio paginados (eventos de mensagem e caixa de correio) para uma caixa de correio no pedido de e-mail fornecido. O e-mail da caixa de correio deve pertencer ao domínio do pedido. Suporta filtros de intervalo de datas e tipo de evento. Os resultados são classificados por timestamp em ordem decrescente.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/logs/mailbox-actions
mail_logs_list-outbound
Recupere logs de entrega de saída (e-mail enviado) paginados para o domínio anexado ao pedido de e-mail fornecido. Suporta filtragem por conta, intervalo de datas, status, remetente e destinatário. Os resultados são classificados por timestamp em ordem decrescente.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/logs/outbound
mail_mailboxes_list
Recupere uma lista paginada de caixas de correio pertencentes a um pedido de e-mail.
Use este endpoint para monitorar caixas de correio do seu serviço de e-mail, incluindo seu status, protocolos habilitados, contagens de recursos anexados e números de uso sincronizados periodicamente (o uso pode ficar defasado em relação aos valores em tempo real).
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/mailboxes
mail_mailboxes_create-mailbox
Crie uma caixa de correio sob o pedido de e-mail fornecido. O endereço de e-mail completo é composto pela parte local fornecida e pelo domínio do pedido.
- Método:
POST - Caminho:
/api/mail/v1/orders/{orderId}/mailboxes
mail_mailboxes_delete-mailbox
Exclua uma caixa de correio. A caixa de correio é excluída de forma suave e permanece restaurável por um período limitado antes de ser removida permanentemente.
- Método:
DELETE - Caminho:
/api/mail/v1/mailboxes/{mailboxId}
mail_mailboxes_change-mailbox-password
Altere a senha de uma caixa de correio.
- Método:
PATCH - Caminho:
/api/mail/v1/mailboxes/{mailboxId}/password
mail_orders_list
Recupere uma lista paginada de pedidos de e-mail associados à sua conta.
Use este endpoint para monitorar seus serviços de e-mail, incluindo seu status, plano, domínio anexado e detalhes de expiração.
- Método:
GET - Caminho:
/api/mail/v1/orders
mail_orders_plan
Recupere o plano com o qual o pedido de e-mail fornecido foi comprado, incluindo cotas de nível de domínio e caixa de correio, limites e disponibilidade de protocolo.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/plan
mail_webhooks_create
Crie um webhook para a caixa de correio fornecida. O segredo gerado é retornado apenas nesta resposta e é enviado como um token de portador com cada entrega.
- Método:
POST - Caminho:
/api/mail/v1/mailboxes/{mailboxId}/webhooks
mail_webhooks_list-delivery-logs
Recupere uma lista paginada de logs de entrega de webhook para o pedido de e-mail fornecido, incluindo resultado da entrega, duração e contagens de tentativas. Suporta filtragem por caixa de correio.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/webhooks/delivery-logs
mail_webhooks_get
Recupere os detalhes de um único webhook. O segredo do webhook nunca é incluído; ele é retornado apenas quando um webhook é criado ou seu segredo é regenerado.
- Método:
GET - Caminho:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_delete
Exclua permanentemente um webhook. Esta ação não pode ser desfeita. Após a exclusão, a URL não recebe mais notificações de eventos.
- Método:
DELETE - Caminho:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_update
Atualize parcialmente um webhook. Apenas os campos incluídos no corpo
da solicitação são alterados; campos omitidos mantêm seus valores atuais. Passe
"description": null para limpar a descrição.
- Método:
PATCH - Caminho:
/api/mail/v1/webhooks/{webhookId}
mail_webhooks_list
Recupere uma lista paginada de webhooks pertencentes ao pedido de e-mail fornecido. Suporta filtragem por caixa de correio e status. O segredo do webhook nunca é incluído; ele é retornado apenas quando um webhook é criado ou seu segredo é regenerado.
- Método:
GET - Caminho:
/api/mail/v1/orders/{orderId}/webhooks
mail_webhooks_regenerate-secret
Regenere o segredo de um webhook. O segredo anterior é imediatamente invalidado. O novo segredo é retornado apenas nesta resposta e é enviado como um token de portador com cada entrega.
- Método:
POST - Caminho:
/api/mail/v1/webhooks/{webhookId}/regenerate-secret
mail_webhooks_test
Envie uma entrega de teste para a URL do webhook e retorne o resultado. Solicitações de teste são limitadas por taxa upstream.
- Método:
POST - Caminho:
/api/mail/v1/webhooks/{webhookId}/test
hostinger-reach-mcp
reach_automations_get
Obtenha uma única automação com as contagens de contatos que entraram nela, estão passando por ela, a concluíram ou falharam no caminho.
Isso descreve a própria automação. Para ver o fluxo de trabalho que ela executa, use o endpoint de etapas.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}
reach_automations_list
Obtenha uma lista paginada das automações em um perfil.
Cada automação vem com as contagens de contatos que entraram nela, estão passando por ela, a concluíram ou falharam no caminho. Essas contagens descrevem a jornada do contato e não são métricas de engajamento de e-mail - para aberturas, cliques e cancelamentos de inscrição, use o endpoint de estatísticas de campanha em vez disso.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/automations
reach_automations_list-steps
Obtém o fluxo de trabalho de uma automação como uma lista plana de etapas.
As etapas formam uma árvore em vez de uma linha reta: siga parent_uuid para reconstruir os
ramos, e use step_order para ordenar as etapas que compartilham um mesmo pai. Uma automação sem
etapas ainda retorna uma lista vazia.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps
reach_campaigns_get
Obtém uma única campanha com seu remetente, assunto, referência de template, segmentação e progresso de entrega.
Isso descreve como a campanha foi configurada e até onde ela chegou. Para aberturas, cliques e cancelamentos de inscrição, use o endpoint de estatísticas da campanha.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}
reach_campaigns_list
Obtém uma lista paginada das campanhas em um perfil.
Cada campanha carrega suas taxas de engajamento principais. Filtre por status para encontrar
rascunhos, campanhas agendadas, em envio ou enviadas, lembrando que uma campanha totalmente
enviada tem o status publish. Por padrão, apenas campanhas regulares são retornadas — passe type para obter os
e-mails enviados por automações ou as confirmações de double opt-in.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/campaigns
reach_campaigns_create-draft
Cria uma campanha em um perfil.
A campanha é criada como rascunho, então nada é enviado e nenhum contato é tocado. Ela também não tem audiência ainda — segmentação e agendamento não fazem parte desta solicitação; o rascunho é finalizado e enviado pela interface do Reach.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/campaigns
reach_campaigns_performance
Obtém o desempenho de uma campanha: entrega, aberturas, cliques e cancelamentos de inscrição, com as taxas correspondentes.
Cada contagem é de contatos únicos, não de eventos brutos, então um contato que abre o mesmo e-mail cinco vezes é contado uma única vez.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics
reach_contacts_delete
Exclui um contato com o UUID especificado.
Este endpoint remove permanentemente um contato do sistema de e-mail marketing.
Obsoleto. Este endpoint não pode direcionar um perfil, então ele sempre recorre ao
perfil padrão do cliente e não pode excluir contatos de nenhum outro perfil. Use
DELETE /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid} em vez disso.
- Método:
DELETE - Caminho:
/api/reach/v1/contacts/{uuid}
reach_contact-fields_delete
Exclui um campo de contato personalizado.
Todos os valores que os contatos possuem para o campo são excluídos junto com ele, e para os tipos de escolha, suas opções também são excluídas. Os próprios contatos não são afetados.
- Método:
DELETE - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}
reach_contact-fields_update
Renomeia um campo de contato personalizado e, para os tipos de escolha, substitui seu conjunto de opções.
Opções com uuid são mantidas e renomeadas, opções sem uuid são criadas, e qualquer opção existente deixada de fora da lista é excluída junto com os valores que os contatos possuem para ela. O tipo do campo e o slug não podem ser alterados.
- Método:
PATCH - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts/fields/{fieldUuid}
reach_contact-fields_list
Obtém os campos de contato personalizados definidos em um perfil.
Campos personalizados permitem armazenar seus próprios atributos nos contatos. Os uuids retornados são o que você passa para o endpoint de atualização de contato para definir valores, e campos de escolha também listam as opções disponíveis para seleção.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts/fields
reach_contact-fields_create
Define um novo campo de contato personalizado em um perfil.
O slug é derivado do rótulo e, como o tipo do campo, não pode ser alterado depois.
Use o uuid retornado para definir valores nos contatos.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts/fields
reach_contacts_list-groups
Obtém uma lista de todos os grupos de contatos.
Este endpoint retorna uma lista de grupos de contatos que podem ser usados para organizar contatos.
- Método:
GET - Caminho:
/api/reach/v1/contacts/groups
reach_contacts_list
Obtém uma lista de contatos, opcionalmente filtrada por grupo e status de inscrição.
Este endpoint retorna uma lista paginada de contatos com suas informações básicas. Você pode filtrar contatos por UUID do grupo e status de inscrição.
Obsoleto. Este endpoint não pode direcionar um perfil, então ele sempre recorre ao
perfil padrão do cliente e não pode listar contatos de nenhum outro perfil. Use
GET /api/reach/v1/profiles/{profileUuid}/contacts em vez disso, que também substitui o
filtro de grupo por um filtro de tag.
- Método:
GET - Caminho:
/api/reach/v1/contacts
reach_contacts_create
Cria um novo contato no sistema de e-mail marketing.
Este endpoint permite criar um novo contato com informações básicas como nome, e-mail e sobrenome.
Se o double opt-in estiver habilitado, o contato será criado com status pendente e um e-mail de confirmação será enviado.
- Método:
POST - Caminho:
/api/reach/v1/contacts
reach_contacts_get
Obtém os detalhes completos de um único contato.
Junto com os atributos do próprio contato, isso retorna as tags atribuídas a ele e os valores que ele possui para os campos de contato personalizados do perfil.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_delete-profile
Exclui permanentemente um contato de um perfil.
O contato é removido junto com seus valores de campos personalizados e atribuições de tags.
- Método:
DELETE - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_update
Atualiza os atributos de um contato e os valores de campos personalizados.
Apenas as propriedades presentes no corpo da solicitação são alteradas, então um corpo parcial é
suficiente para alterar um único atributo. Enviar uma propriedade como null a limpa.
A resposta carrega os atributos principais do contato. Leia de volta suas tags, valores de campos
personalizados, origem e nota com GET /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}.
- Método:
PATCH - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}
reach_contacts_create-in-bulk
Cria muitos contatos em um perfil em uma única chamada.
Os contatos são importados em segundo plano, então uma resposta de sucesso significa que a importação foi aceita, não concluída. Contatos cujo e-mail já existe no perfil são deixados como estão. Se o double opt-in estiver habilitado, novos contatos começam como pendentes e recebem um e-mail de confirmação.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts/bulk
reach_contacts_list-profile
Obtém uma lista paginada de contatos pertencentes a um perfil.
Os contatos podem ser filtrados por status de inscrição, por tag e por um termo de busca de e-mail.
O campo meta.total da resposta é o número de contatos que correspondem aos filtros,
então chamar este endpoint sem filtros dá a contagem total de contatos do perfil.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts
reach_contacts_create-bulk
Cria um novo contato no sistema de e-mail marketing.
Este endpoint permite criar um novo contato com informações básicas como nome, e-mail e sobrenome.
Se o double opt-in estiver habilitado, o contato será criado com status pendente e um e-mail de confirmação será enviado.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/contacts
reach_segments_list
Obtém uma lista de todos os segmentos de contatos.
Este endpoint retorna uma lista de segmentos de contatos que podem ser usados para organizar contatos.
Obsoleto. Este endpoint não pode direcionar um perfil, então ele sempre recorre ao
perfil padrão do cliente e não pode listar os segmentos de nenhum outro perfil. Use
GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments em vez disso.
- Método:
GET - Caminho:
/api/reach/v1/segmentation/segments
reach_segments_create
Cria um novo segmento de contatos.
Este endpoint permite criar um novo segmento de contatos que pode ser usado para organizar contatos. O segmento pode ser configurado com critérios específicos como e-mail, nome, status de inscrição, etc.
Obsoleto. Este endpoint não pode direcionar um perfil, então ele sempre recorre ao
perfil padrão do cliente e não pode criar segmentos em nenhum outro perfil. Use
POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments em vez disso.
- Método:
POST - Caminho:
/api/reach/v1/segmentation/segments
reach_segments_count-profile-contacts
Conta os contatos que atualmente correspondem a um segmento sem listá-los.
Mais barato do que paginar pelo endpoint de contatos do segmento quando apenas o tamanho é necessário.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/count
reach_segments_list-profile-contacts
Recupera contatos associados a um segmento específico para um determinado perfil.
Este endpoint permite buscar e filtrar contatos que pertencem a um segmento específico, identificado por seu UUID, com escopo em um perfil específico.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts
reach_segments_profile
Obtém um único segmento de um perfil, incluindo as condições que o definem.
Para recuperar os contatos que atualmente correspondem a essas condições, use o endpoint de contatos do segmento em vez disso.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_update-profile
Renomeia um segmento e/ou substitui as condições que o definem.
name é sempre obrigatório. Omita conditions para renomear sem tocar nas condições;
forneça-as e elas substituirão o conjunto existente por completo, em vez de serem mescladas a ele.
Os contatos nunca são modificados, mas quais deles correspondem ao segmento pode mudar imediatamente.
- Método:
PUT - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_delete-profile
Exclui um segmento.
Apenas a definição do segmento é removida. Os contatos que correspondiam a ele são deixados intactos.
- Método:
DELETE - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}
reach_segments_list-filter-attributes
Lista todos os atributos que uma condição de segmento pode filtrar, com os operadores que cada atributo aceita, o formato de valor que eles esperam e, onde o valor é restrito, os valores permitidos.
A lista é específica do perfil: ela inclui os campos de contato personalizados do perfil, suas tags e
suas 20 campanhas mais recentemente publicadas, então os atributos válidos não podem ser codificados.
Leia-a antes de criar ou atualizar um segmento para descobrir as combinações válidas de attribute, operator e
value.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/filters/attributes
reach_segments_preview-contacts-matching-conditions
Pré-visualiza os contatos que correspondem a um conjunto de condições sem salvar um segmento.
O corpo é o mesmo conjunto de condições aceito ao criar ou atualizar um segmento, então esta é a forma de verificar quem um filtro alcança, e quantos, antes de persistir. Nada é armazenado e nenhum contato é modificado.
Chame o endpoint de atributos de filtro do segmento primeiro para descobrir as combinações válidas de attribute,
operator e value.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/filters/contacts
reach_segments_list-profile
Obtém uma lista paginada dos segmentos definidos em um perfil.
Cada entrada carrega o número de contatos que atualmente correspondem a ele, que é recalculado na
leitura em vez de armazenado. Use count_type para contar todos os contatos correspondentes ou apenas
os inscritos.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments
reach_segments_create-profile
Cria um segmento em um perfil.
Um segmento é um conjunto salvo de condições em vez de uma lista fixa, então sua composição muda conforme os contatos mudam. Criar um não modifica nenhum contato.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/segmentation/segments
reach_segments_list-contacts
Recupera contatos associados a um segmento específico.
Este endpoint permite buscar e filtrar contatos que pertencem a um segmento específico, identificado por seu UUID.
Obsoleto. Este endpoint não pode direcionar um perfil, então ele sempre recorre ao
perfil padrão do cliente e não pode ler segmentos de nenhum outro perfil. Use
GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts em vez disso.
- Método:
GET - Caminho:
/api/reach/v1/segmentation/segments/{segmentUuid}/contacts
reach_segments_get
Obtém detalhes de um segmento específico.
Este endpoint recupera informações sobre um único segmento identificado por UUID.
Segmentos são usados para organizar e agrupar contatos com base em critérios específicos.
Obsoleto. Este endpoint não pode direcionar um perfil, então ele sempre recorre ao
perfil padrão do cliente e não consegue ler segmentos de nenhum outro perfil. Use
GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid} em vez disso.
- Método:
GET - Caminho:
/api/reach/v1/segmentation/segments/{segmentUuid}
reach_tags_assign-contact-to
Atribui uma tag a um único contato.
Diferente do endpoint em massa, isso é aplicado imediatamente em vez de ser enfileirado. Atribuir uma tag que o contato já possui é bem-sucedido sem duplicá-la.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}
reach_tags_remove-contact-from
Remove uma tag de um único contato.
Diferente do endpoint em massa, isso é aplicado imediatamente em vez de ser enfileirado. Nem a tag nem o contato são excluídos.
- Método:
DELETE - Caminho:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts/{contactUuid}
reach_tags_assign-contacts-to
Atribui uma tag a vários contatos de uma vez.
Passe contact_uuids para direcionar contatos específicos, ou all_contacts para direcionar todos os contatos
no perfil. O trabalho é enfileirado, então uma resposta de sucesso significa que foi aceito, não
concluído. Contatos que já possuem a tag não são alterados.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts
reach_tags_remove-contacts-from
Remove uma tag de vários contatos de uma vez.
Passe contact_uuids para direcionar contatos específicos, ou all_contacts para direcionar todos os contatos
no perfil. O trabalho é enfileirado, então uma resposta de sucesso significa que foi aceito, não
concluído. A tag em si e os contatos não são excluídos.
- Método:
DELETE - Caminho:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}/contacts
reach_tags_delete
Exclui uma tag e a remove de todos os contatos que a possuem.
Os contatos em si não são excluídos. Isso é idempotente: excluir uma tag que não existe no perfil ainda é bem-sucedido.
- Método:
DELETE - Caminho:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}
reach_tags_rename
Renomeia uma tag.
Os contatos atribuídos à tag não são afetados. Os nomes são únicos dentro de um perfil, então renomear uma tag para um nome que já está em uso é rejeitado.
- Método:
PATCH - Caminho:
/api/reach/v1/profiles/{profileUuid}/tags/{tagUuid}
reach_tags_list-profile
Obtém todas as tags definidas em um perfil.
As tags são a forma como os contatos são agrupados no Reach e podem ser usadas para filtrar a lista de contatos ou para construir segmentos.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/tags
reach_tags_create-or-find
Cria tags em um perfil.
Nomes que já existem no perfil não são duplicados: a tag existente é retornada em vez disso, então a chamada é segura para repetir. Toda tag na solicitação é retornada, seja ela criada agora ou já existente.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/tags
reach_forms_get
Obtém um único formulário com a URL do seu template hospedado e as tags que ele aplica aos contatos que captura.
Não há um snippet de incorporação pronto na resposta — sirva o HTML do template você mesmo ou crie sua própria incorporação em torno do uuid do formulário.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}
reach_forms_delete
Exclui permanentemente um formulário junto com seu template.
Um formulário que já capturou envios não pode ser excluído, para que os contatos que ele coletou nunca sejam descartados silenciosamente — pause o formulário para impedir que ele colete novos. Apenas visualizações não bloqueiam a exclusão.
- Método:
DELETE - Caminho:
/api/reach/v1/profiles/{profileUuid}/forms/{formUuid}
reach_forms_list
Obtém uma lista paginada dos formulários de inscrição em um perfil.
Cada formulário carrega uma referência ao template que o renderiza. Obtenha os detalhes do formulário para uma URL de template diretamente utilizável e para as tags que o formulário aplica aos contatos que captura.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/forms
reach_profiles_connected-sending-domain
Obtém o domínio de envio conectado ao perfil, seu status de verificação e quaisquer endereços de remetente suspensos.
As campanhas só são enviadas depois que um domínio é conectado e ativo, então esta é a forma mais barata de
verificar essa pré-condição antes de criar uma. Um perfil sem domínio conectado retorna a
mesma estrutura com todos os campos definidos como null. Para os registros individuais MX, SPF, DKIM e DMARC
por trás do status, use o endpoint de status de DNS.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_connect-sending-domain
Conecta um domínio de envio ao perfil para que e-mails possam ser enviados de endereços nele.
Conectar não torna o domínio pronto para envio: verifique o endpoint de status de DNS em seguida para
registros que ainda estão faltando. Um domínio que a conta possui ou já verificou conecta
imediatamente. Qualquer outro domínio inicia uma verificação de propriedade TXT e retorna 409;
complete a verificação no Reach e tente novamente. Retorna 422 quando o perfil ou outro perfil
já possui o domínio, o domínio está bloqueado ou sua propriedade não pode ser verificada.
Um domínio já conectado nunca é substituído.
Em caso de sucesso, o endereço do remetente de campanhas de rascunho e agendadas, e de automações publicadas
e e-mails de duplo opt-in, muda para o novo domínio em segundo plano, mantendo a parte
antes do @.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_delete-sending-domain
Desconecta o domínio de envio do perfil.
O registro do domínio é removido, então o perfil não tem domínio de envio depois disso e as campanhas não podem ser enviadas até que um domínio seja conectado novamente. Endereços de remetente já armazenados em campanhas, automações e configurações não são alterados e continuam apontando para o domínio removido. Um domínio que não está conectado ao perfil também é bem-sucedido, então o sucesso não é prova de que algo foi excluído. Os registros DNS no provedor de DNS não são removidos. Para trocar de domínio, exclua este e conecte o novo. Confirme o domínio com o cliente antes de chamar.
- Método:
DELETE - Caminho:
/api/reach/v1/profiles/{profileUuid}/domains
reach_profiles_domain-dns-status
Recupera o status da configuração de DNS para o domínio de um perfil.
Este endpoint relata o estado dos registros MX, SPF, DKIM e DMARC, incluindo os registros reais encontrados e os registros sugeridos necessários para a entrega correta de e-mails.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/domains/dns-status
reach_profiles_list-plan-feature-access
Lista quais recursos do plano o perfil pode usar.
Esta é a matriz de bloqueio de recursos, não uma cota de uso. available significa que o recurso pode ser
usado agora e locked significa que não faz parte do plano base, então um upgrade é necessário.
Para e-mails restantes, destinatários e créditos de IA, use o endpoint de limites.
Vale a pena verificar antes de criar algo que não pode ser ativado depois, como uma automação em um plano sem ativação de automação.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/features
reach_profiles_remaining-plan-limits
Obtém quanto do plano resta para o período atual.
Duas coisas para ter em mente antes de criar alertas sobre isso. O período é um mês calendário em vez de um aniversário de cobrança, então os contadores são redefinidos no dia 1º, não importa quando a assinatura começou. E o uso é rastreado por pedido, então todo perfil no mesmo pedido compartilha um pool e relata os mesmos números aqui. Apenas o período atual está disponível; o uso passado não é mantido.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/limits
reach_profiles_list
Este endpoint retorna todos os perfis disponíveis para o cliente, incluindo suas informações básicas.
- Método:
GET - Caminho:
/api/reach/v1/profiles
reach_profiles_settings
Obtém a identidade de remetente salva e os detalhes da marca do perfil.
Leia o remetente padrão antes de criar uma campanha em vez de perguntar ao cliente, e
reutilize os campos da marca ao gerar conteúdo de e-mail. Qualquer campo pode ser null para um perfil
que nunca preencheu suas configurações. Isso não verifica se o domínio de envio está
verificado; use o endpoint de domínio de envio conectado para isso.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/settings
reach_profiles_update-settings
Altera o remetente padrão e os detalhes da marca do perfil.
Envie apenas os campos a alterar: todo campo omitido mantém seu valor, e null ou uma string vazia
limpa um campo de texto. O remetente padrão é o que as campanhas criadas depois começam
com; campanhas existentes mantêm seu próprio remetente. sender_email é apenas a parte antes do
@, porque o Reach o combina com o domínio de envio conectado do perfil, então um endereço
fora desse domínio não pode ser definido. Conectar um domínio de envio é um endpoint separado e
um domínio conectado não pode ser alterado aqui. Retorna as configurações após a alteração.
- Método:
PATCH - Caminho:
/api/reach/v1/profiles/{profileUuid}/settings
reach_templates_list-email
Obtém uma lista dos templates de e-mail em um perfil, mais recentemente atualizados primeiro.
Templates são os corpos de e-mail reutilizáveis a partir dos quais uma campanha é construída. A lista não é paginada
e apenas os metadados são retornados — o conteúdo do template em si não é exposto. Use o
uuid de um template como o template_uuid ao criar uma campanha.
- Método:
GET - Caminho:
/api/reach/v1/profiles/{profileUuid}/templates
reach_templates_create-email
Cria um template de e-mail em um perfil.
O template contém o corpo HTML que uma campanha reutiliza, então ele pode ser criado antes de qualquer
campanha existir. Apenas os metadados do template são retornados — guarde o uuid retornado para
referenciá-lo como o template_uuid de uma campanha.
- Método:
POST - Caminho:
/api/reach/v1/profiles/{profileUuid}/templates
hostinger-vps-mcp
vps_data-centers_list
Recupera todos os data centers disponíveis.
Use este endpoint para visualizar as opções de localização antes de implantar instâncias de VPS.
- Método:
GET - Caminho:
/api/vps/v1/data-centers
vps_docker_containers
Recupera uma lista de todos os contêineres pertencentes a um projeto Docker Compose específico na máquina virtual.
Este endpoint retorna informações detalhadas sobre cada contêiner, incluindo seu status atual, mapeamentos de porta e configuração de tempo de execução.
Use isso para monitorar a saúde e o estado de todos os serviços dentro do seu projeto Docker Compose.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers
vps_docker_get
Recupera as informações completas do projeto, incluindo o conteúdo do arquivo docker-compose.yml, metadados do projeto e status de implantação atual.
Este endpoint fornece a configuração completa e os detalhes de estado de um projeto Docker Compose específico.
Use isso para inspecionar as configurações do projeto, revisar o arquivo compose ou verificar a saúde geral do projeto.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}
vps_docker_delete
Remove completamente um projeto Docker Compose da máquina virtual, parando todos os contêineres e limpando recursos associados, incluindo redes, volumes e imagens.
Esta operação é irreversível e excluirá todos os dados do projeto.
Use isso quando quiser remover permanentemente um projeto e liberar recursos do sistema.
- Método:
DELETE - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down
vps_docker_list
Recupera uma lista de todos os projetos Docker Compose atualmente implantados na máquina virtual.
Este endpoint retorna informações básicas sobre cada projeto, incluindo nome,
status, caminho do arquivo e lista de contêineres com detalhes sobre seus nomes,
imagens, status, saúde e portas. As estatísticas dos contêineres são omitidas neste
endpoint. Se você precisar de informações detalhadas sobre um contêiner com
estatísticas incluídas, use o endpoint Get project containers.
Use isso para obter uma visão geral de todos os projetos Docker na sua instância VPS.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker
vps_docker_create
Implanta um novo projeto a partir do conteúdo do docker-compose.yaml ou baixa o conteúdo de uma URL. A URL pode ser uma URL de repositório do Github no formato https://github.com/[user]/[repo] e será resolvida automaticamente para o arquivo docker-compose.yaml no branch master. Qualquer outra URL fornecida deve retornar o conteúdo do arquivo docker-compose.yaml.
Se já existir um projeto com o mesmo nome, o projeto existente será substituído.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker
vps_docker_logs
Recupera entradas de log agregadas de todos os serviços dentro de um projeto Docker Compose.
Este endpoint retorna a saída de log recente de cada contêiner, organizada por nome de serviço com carimbos de data/hora. A resposta contém as últimas 300 entradas de log em todos os serviços.
Use isto para depuração, monitoramento do comportamento da aplicação e solução de problemas em toda a pilha do seu projeto.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs
vps_docker_restart
Reinicia todos os serviços em um projeto Docker Compose, parando e iniciando os contêineres na ordem correta de dependências.
Esta operação preserva os volumes de dados e as configurações de rede enquanto atualiza os contêineres em execução.
Use isto para aplicar alterações de configuração ou recuperar-se de falhas de serviço.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart
vps_docker_start
Inicia todos os serviços em um projeto Docker Compose que estão atualmente parados.
Esta operação ativa os contêineres na ordem correta de dependências, conforme definido no arquivo compose.
Use isto para retomar um projeto que foi parado anteriormente ou para iniciar serviços após uma reinicialização do sistema.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start
vps_docker_stop
Para todos os serviços em execução em um projeto Docker Compose, preservando as configurações dos contêineres e os volumes de dados.
Esta operação desliga os contêineres graciosamente na ordem inversa de dependências.
Use isto para interromper temporariamente um projeto sem remover dados ou configurações.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop
vps_docker_update
Atualiza um projeto Docker Compose baixando as versões mais recentes das imagens e recriando os contêineres com as novas configurações.
Esta operação preserva os volumes de dados enquanto aplica as alterações do arquivo compose.
Use isto para implantar atualizações de aplicativos, aplicar alterações de configuração ou atualizar as imagens dos contêineres para suas versões mais recentes.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update
vps_firewall_activate
Ativa um firewall para uma máquina virtual especificada.
Apenas um firewall pode estar ativo para uma máquina virtual por vez.
Use este endpoint para aplicar regras de firewall a instâncias VPS.
- Método:
POST - Caminho:
/api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}
vps_firewall_deactivate
Desativa um firewall para uma máquina virtual especificada.
Use este endpoint para remover a proteção de firewall de instâncias VPS.
- Método:
POST - Caminho:
/api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}
vps_firewall_get
Recupera o firewall pelo seu ID e as regras associadas a ele.
Use este endpoint para visualizar a configuração e as regras específicas do firewall.
- Método:
GET - Caminho:
/api/vps/v1/firewall/{firewallId}
vps_firewall_delete
Exclui um firewall especificado.
Qualquer máquina virtual que tenha este firewall ativado terá ele desativado automaticamente.
Use este endpoint para remover configurações de firewall não utilizadas.
- Método:
DELETE - Caminho:
/api/vps/v1/firewall/{firewallId}
vps_firewall_list
Recupera todos os firewalls disponíveis.
Use este endpoint para visualizar as configurações de firewall existentes.
- Método:
GET - Caminho:
/api/vps/v1/firewall
vps_firewall_create
Cria um novo firewall.
Use este endpoint para configurar novas regras de firewall para a segurança do VPS.
- Método:
POST - Caminho:
/api/vps/v1/firewall
vps_firewall_update-rule
Atualiza uma regra específica de firewall de um firewall especificado.
Qualquer máquina virtual que tenha este firewall ativado perderá a sincronização com o firewall e terá que ser sincronizada novamente manualmente.
Use este endpoint para modificar regras de firewall existentes.
- Método:
PUT - Caminho:
/api/vps/v1/firewall/{firewallId}/rules/{ruleId}
vps_firewall_delete-rule
Exclui uma regra específica de firewall de um firewall especificado.
Qualquer máquina virtual que tenha este firewall ativado perderá a sincronização com o firewall e terá que ser sincronizada novamente manualmente.
Use este endpoint para remover regras de firewall específicas.
- Método:
DELETE - Caminho:
/api/vps/v1/firewall/{firewallId}/rules/{ruleId}
vps_firewall_replace-all-rules-in-group
Substitui todas as regras de firewall dentro de um grupo de firewall especificado pelo conjunto de regras fornecido em uma única operação atômica, em vez de criar ou excluir regras uma a uma.
Qualquer máquina virtual que use este grupo de firewall precisará ser sincronizada após a substituição das regras; passe o parâmetro "sync" para acionar a sincronização imediatamente.
- Método:
PUT - Caminho:
/api/vps/v1/firewall/{firewallId}/rules
vps_firewall_create-rule
Cria uma nova regra de firewall para um firewall especificado.
Por padrão, o firewall descarta todo o tráfego de entrada, o que significa que você deve adicionar regras de aceite para todas as portas que deseja usar.
Qualquer máquina virtual que tenha este firewall ativado perderá a sincronização com o firewall e terá que ser sincronizada novamente manualmente.
Use este endpoint para adicionar novas regras de segurança aos firewalls.
- Método:
POST - Caminho:
/api/vps/v1/firewall/{firewallId}/rules
vps_firewall_sync-to-all-assigned-v-ms
Sincroniza as regras de um firewall para todas as máquinas virtuais às quais ele está atribuído.
O firewall pode perder a sincronização com uma máquina virtual se o firewall tiver novas regras adicionadas, removidas ou atualizadas.
Use este endpoint para aplicar regras de firewall atualizadas a todas as instâncias VPS atribuídas ao firewall.
- Método:
POST - Caminho:
/api/vps/v1/firewall/{firewallId}/sync
vps_firewall_sync
Obsoleto: use POST /api/vps/v1/firewall/{firewallId}/sync em vez disso, que sincroniza o firewall
com todas as máquinas virtuais às quais ele está atribuído.
Sincroniza um firewall para uma máquina virtual especificada.
O firewall pode perder a sincronização com a máquina virtual se o firewall tiver novas regras adicionadas, removidas ou atualizadas.
Use este endpoint para aplicar regras de firewall atualizadas a instâncias VPS.
- Método:
POST - Caminho:
/api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}
vps_post-install-scripts_get
Recupera o script pós-instalação pelo seu ID.
Use este endpoint para visualizar detalhes específicos do script de automação.
- Método:
GET - Caminho:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_update
Atualiza um script pós-instalação específico.
Use este endpoint para modificar scripts de automação existentes.
- Método:
PUT - Caminho:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_delete
Exclui um script pós-instalação da sua conta.
Use este endpoint para remover scripts de automação não utilizados.
- Método:
DELETE - Caminho:
/api/vps/v1/post-install-scripts/{postInstallScriptId}
vps_post-install-scripts_list
Recupera scripts pós-instalação associados à sua conta.
Use este endpoint para visualizar os scripts de automação disponíveis para implantação de VPS.
- Método:
GET - Caminho:
/api/vps/v1/post-install-scripts
vps_post-install-scripts_create
Adiciona um novo script pós-instalação à sua conta, que pode ser usado após a instalação da máquina virtual.
O conteúdo do script será salvo no arquivo /post_install com o atributo executável definido
e será executado assim que a máquina virtual for instalada.
A saída do script será redirecionada para /post_install.log. O tamanho máximo do script é 48KB.
Use este endpoint para criar scripts de automação para tarefas de configuração de VPS.
- Método:
POST - Caminho:
/api/vps/v1/post-install-scripts
vps_public-keys_attach
Obsoleto: use POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys em vez disso.
Anexa chaves públicas existentes da sua conta a uma máquina virtual especificada.
Várias chaves podem ser anexadas a uma única máquina virtual.
Use este endpoint para habilitar a autenticação por chave SSH para instâncias VPS.
- Método:
POST - Caminho:
/api/vps/v1/public-keys/attach/{virtualMachineId}
vps_public-keys_delete
Obsoleto: chaves públicas de nível de conta não têm substituição direta. As chaves SSH raiz agora são gerenciadas por
máquina virtual via DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys.
Exclui uma chave pública da sua conta.
Excluir a chave pública da conta não a remove da máquina virtual
Use este endpoint para remover chaves SSH não utilizadas da conta.
- Método:
DELETE - Caminho:
/api/vps/v1/public-keys/{publicKeyId}
vps_public-keys_list
Obsoleto: chaves públicas de nível de conta não têm substituição direta. As chaves SSH raiz agora são gerenciadas por
máquina virtual via GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys.
Recupera chaves públicas associadas à sua conta.
Use este endpoint para visualizar as chaves SSH disponíveis para autenticação de VPS.
- Método:
GET - Caminho:
/api/vps/v1/public-keys
vps_public-keys_create
Obsoleto: chaves públicas de nível de conta não têm substituição direta. As chaves SSH raiz agora são gerenciadas por
máquina virtual via POST /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys.
Adiciona uma nova chave pública à sua conta.
Use este endpoint para registrar chaves SSH para autenticação de VPS.
- Método:
POST - Caminho:
/api/vps/v1/public-keys
vps_ssh-keys_list-virtual-machine
Recupera as chaves públicas SSH atualmente configuradas em uma máquina virtual especificada.
Apenas as chaves do usuário root são listadas.
Use este endpoint para visualizar as chaves SSH que podem ser usadas para autenticação em instâncias VPS.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_ssh-keys_add-virtual-machine
Adiciona uma ou mais chaves públicas SSH a uma máquina virtual especificada.
As chaves são adicionadas ao usuário root e podem ser usadas para autenticação SSH sem senha.
Retorna a lista completa de chaves SSH atualmente configuradas na máquina virtual.
Use este endpoint para habilitar a autenticação por chave SSH para instâncias VPS.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_ssh-keys_remove-virtual-machine
Remove uma ou mais chaves públicas SSH de uma máquina virtual especificada.
As chaves removidas não podem mais ser usadas para autenticar via SSH como o usuário root.
Retorna a lista restante de chaves SSH configuradas na máquina virtual.
Use este endpoint para revogar o acesso por chave SSH a instâncias VPS.
- Método:
DELETE - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys
vps_templates_get
Recupera informações detalhadas sobre um modelo de sistema operacional específico para máquinas virtuais.
Use este endpoint para visualizar especificações específicas do modelo antes da implantação.
- Método:
GET - Caminho:
/api/vps/v1/templates/{templateId}
vps_templates_list
Recupera os modelos de sistema operacional disponíveis para máquinas virtuais.
Use este endpoint para visualizar as opções de sistema operacional antes de criar ou recriar instâncias VPS.
- Método:
GET - Caminho:
/api/vps/v1/templates
vps_actions_get
Recupera informações detalhadas sobre uma ação específica executada em uma máquina virtual especificada.
Use este endpoint para monitorar o status e os detalhes de uma operação específica de VPS.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}
vps_actions_list
Recupera ações executadas em uma máquina virtual especificada.
Ações são operações ou eventos que foram executados na máquina virtual, como iniciar, parar ou modificar a máquina. Este endpoint permite visualizar o histórico dessas ações, fornecendo detalhes sobre cada ação, como o nome da ação, carimbo de data/hora e status.
Use este endpoint para visualizar o histórico de operações de VPS e solucionar problemas.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/actions
vps_virtual-machines_attached-public-keys
Obsoleto: use GET /api/vps/v1/virtual-machines/{virtualMachineId}/ssh-keys em vez disso.
Recupera chaves públicas anexadas a uma máquina virtual especificada.
Use este endpoint para visualizar as chaves SSH configuradas para instâncias VPS específicas.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/public-keys
vps_backups_list
Recupera backups para uma máquina virtual especificada.
Use este endpoint para visualizar os pontos de backup disponíveis para recuperação de dados de VPS.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/backups
vps_backups_restore
Restaura um backup para uma máquina virtual especificada. O sistema então iniciará o processo de restauração, que pode levar algum tempo dependendo do tamanho do backup.
Todos os dados na máquina virtual serão sobrescritos com os dados do backup.
Use este endpoint para recuperar dados de VPS a partir de pontos de backup.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore
vps_virtual-machines_set-hostname
Define o hostname para uma máquina virtual especificada.
Alterar o hostname não atualiza o registro PTR automaticamente. Se você quiser que sua máquina virtual seja acessível por um hostname, você também precisa apontar os registros A/AAAA do seu domínio para o IP da máquina virtual.
Use este endpoint para configurar hostnames personalizados para instâncias de VPS.
- Método:
PUT - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/hostname
vps_virtual-machines_reset-hostname
Redefine o hostname e o registro PTR de uma máquina virtual especificada para o valor padrão.
Use este endpoint para restaurar a configuração padrão de hostname para instâncias de VPS.
- Método:
DELETE - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/hostname
vps_virtual-machines_get
Recupera informações detalhadas sobre uma máquina virtual especificada.
Use este endpoint para visualizar a configuração e o status abrangentes da VPS.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}
vps_virtual-machines_list
Recupera todas as máquinas virtuais disponíveis.
Use este endpoint para visualizar as instâncias de VPS disponíveis.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines
vps_virtual-machines_purchase
Compra e configura uma nova máquina virtual.
Se a configuração da máquina virtual falhar por qualquer motivo, faça login no hPanel e conclua a configuração manualmente.
Se nenhum método de pagamento for fornecido, seu método de pagamento padrão será usado automaticamente.
Se a resposta for 202 Accepted, o pagamento ainda está sendo processado e a máquina virtual
não foi configurada. Faça login no
hPanel e conclua a configuração manualmente.
Use este endpoint para criar novas instâncias de VPS.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines
vps_monarx_scan-metrics
Recupera métricas de varredura para o scanner de malware Monarx instalado em uma máquina virtual especificada.
As métricas de varredura fornecem informações detalhadas sobre as varreduras de malware realizadas pelo Monarx, incluindo o número de varreduras, ameaças detectadas e outras estatísticas relevantes. Essas informações são úteis para monitorar o status de segurança da máquina virtual e avaliar a eficácia do scanner de malware.
Use este endpoint para monitorar resultados de varredura de segurança e detecção de ameaças da VPS.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_monarx_install
Instala o scanner de malware Monarx em uma máquina virtual especificada.
Monarx é uma ferramenta de segurança projetada para detectar e prevenir infecções por malware em máquinas virtuais. Ao instalar o Monarx, os usuários podem aumentar a segurança de suas máquinas virtuais, garantindo que estejam protegidas contra software malicioso.
Use este endpoint para habilitar a proteção contra malware em instâncias de VPS.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_monarx_uninstall
Desinstala o scanner de malware Monarx em uma máquina virtual especificada.
Se o Monarx não estiver instalado, a solicitação ainda será processada sem nenhum efeito.
Use este endpoint para remover o scanner de malware de instâncias de VPS.
- Método:
DELETE - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/monarx
vps_virtual-machines_metrics
Recupera métricas históricas para uma máquina virtual especificada.
Isso inclui as seguintes métricas:
- Uso de CPU
- Uso de memória
- Uso de disco
- Uso de rede
- Tempo de atividade
Use este endpoint para monitorar o desempenho da VPS e a utilização de recursos ao longo do tempo.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/metrics
vps_virtual-machines_set-nameservers
Define servidores de nomes para uma máquina virtual especificada.
Esteja ciente de que uma configuração inadequada de servidores de nomes pode fazer com que a máquina virtual não consiga resolver nomes de domínio.
Use este endpoint para configurar resolvedores DNS personalizados para instâncias de VPS.
- Método:
PUT - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/nameservers
vps_ptr_create
Cria ou atualiza um registro PTR (Pointer) para uma máquina virtual especificada.
Use este endpoint para configurar a consulta DNS reversa para endereços IP de VPS.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}
vps_ptr_delete
Exclui um registro PTR (Pointer) para uma máquina virtual especificada.
Uma vez excluído, as consultas DNS reversas para o endereço IP da máquina virtual não retornarão mais o hostname configurado anteriormente.
Use este endpoint para remover a configuração de DNS reverso de instâncias de VPS.
- Método:
DELETE - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}
vps_virtual-machines_set-panel-password
Define a senha do painel para uma máquina virtual especificada.
Se a máquina virtual não usar o sistema operacional do painel, a solicitação ainda será processada sem nenhum efeito. Os requisitos para a senha são os mesmos do endpoint de recriação de máquina virtual.
Use este endpoint para configurar as credenciais de acesso ao painel de controle para instâncias de VPS.
- Método:
PUT - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/panel-password
vps_recovery_start
Inicia o modo de recuperação para uma máquina virtual especificada.
O modo de recuperação é um estado especial que permite aos usuários realizar operações de resgate do sistema, como reparar sistemas de arquivos, recuperar dados ou solucionar problemas que impedem a máquina virtual de inicializar normalmente.
A máquina virtual inicializará a imagem do disco de recuperação e a imagem do disco original será montada no diretório /mnt.
Use este endpoint para habilitar operações de resgate do sistema em instâncias de VPS.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/recovery
vps_recovery_stop
Interrompe o modo de recuperação para uma máquina virtual especificada.
Se a máquina virtual não estiver no modo de recuperação, esta operação falhará.
Use este endpoint para sair do modo de resgate do sistema e retornar a VPS à operação normal.
- Método:
DELETE - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/recovery
vps_virtual-machines_recreate
Recria uma máquina virtual do zero.
O processo de recriação envolve a reinstalação do sistema operacional e a redefinição da máquina virtual ao seu estado inicial. Os snapshots, se houver, serão excluídos.
Requisitos de Senha
A senha será verificada em bancos de dados de senhas vazadas. Os requisitos para a senha são:
- Pelo menos 12 caracteres
- Pelo menos uma letra maiúscula
- Pelo menos uma letra minúscula
- Pelo menos um número
- Não ter sido vazada publicamente
Esta operação é irreversível e resultará na perda de todos os dados armazenados na máquina virtual!
Use este endpoint para reconstruir completamente instâncias de VPS com uma instalação nova do sistema operacional.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/recreate
vps_virtual-machines_restart
Reinicia uma máquina virtual especificada parando e iniciando-a completamente.
Se a máquina virtual estava parada, ela será iniciada.
Use este endpoint para reiniciar instâncias de VPS.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/restart
vps_virtual-machines_set-root-password
Define a senha de root para uma máquina virtual especificada.
Os requisitos para a senha são os mesmos do endpoint de recriação de máquina virtual.
Use este endpoint para atualizar as credenciais de administrador para instâncias de VPS.
- Método:
PUT - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/root-password
vps_virtual-machines_setup
Configura uma máquina virtual recém-adquirida com o estado initial.
Use este endpoint para configurar e inicializar instâncias de VPS adquiridas.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/setup
vps_snapshots_get
Recupera o snapshot de uma máquina virtual especificada.
Use este endpoint para visualizar as informações atuais do snapshot da VPS.
- Método:
GET - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_create
Cria um snapshot de uma máquina virtual especificada.
Um snapshot captura o estado e os dados da máquina virtual em um ponto específico no tempo, permitindo que os usuários restaurem a máquina virtual para esse estado, se necessário. Esta operação é útil para fins de backup, recuperação do sistema e teste de alterações sem afetar o estado atual da máquina virtual.
Criar um novo snapshot sobrescreverá o snapshot existente!
Use este endpoint para capturar o estado da VPS para fins de backup e recuperação.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_delete
Exclui um snapshot de uma máquina virtual especificada.
Use este endpoint para remover snapshots de VPS.
- Método:
DELETE - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot
vps_snapshots_restore
Restaura uma máquina virtual especificada para um estado anterior usando um snapshot.
Restaurar a partir de um snapshot permite que os usuários revertam a máquina virtual para esse estado, o que é útil para recuperação do sistema, desfazer alterações ou testes.
Use este endpoint para reverter instâncias de VPS para estados salvos anteriores.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore
vps_virtual-machines_start
Inicia uma máquina virtual especificada.
Se a máquina virtual já estiver em execução, a solicitação ainda será processada sem nenhum efeito.
Use este endpoint para ligar instâncias de VPS paradas.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/start
vps_virtual-machines_stop
Para uma máquina virtual especificada.
Se a máquina virtual já estiver parada, a solicitação ainda será processada sem nenhum efeito.
Esta é apenas uma alteração de estado de energia computacional e não afeta a cobrança. Para interromper cobranças futuras, desative a renovação automática na assinatura proprietária.
Use este endpoint para desligar instâncias de VPS em execução.
- Método:
POST - Caminho:
/api/vps/v1/virtual-machines/{virtualMachineId}/stop
hostinger-wordpress-mcp
wordpress_ai-content_generate-images
Começa a gerar uma ou mais imagens a partir de um prompt e um tipo de imagem para a instalação
WordPress especificada. A geração é executada de forma assíncrona: a resposta é retornada
imediatamente com status: in-progress e um generation_id. Consulte
GET /api/hosting/v1/accounts/{username}/wordpress/{software}/content/generations/{generation_id}
a cada poucos segundos até que status seja completed ou failed.
Uma geração concluída retorna URLs temporárias de imagens juntamente com o tempo de expiração; baixe as imagens antes disso. As imagens correspondem à proporção solicitada e nunca são menores que o tamanho solicitado; logotipos são imagens transparentes recortadas na marca.
Apenas uma geração de imagem pode ser executada por instalação por vez: enquanto uma ainda estiver em
andamento, o endpoint retorna 409 sem o ID da geração em execução, então um chamador
que não recebeu o 202 deve aguardar a conclusão (até alguns minutos) antes de
iniciar uma nova. O endpoint é limitado a 10 solicitações por minuto.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/content/images/generate
wordpress_ai-content_generation-result
Obtém o resultado de uma geração de conteúdo de IA iniciada para a instalação WordPress especificada, como uma geração de imagem iniciada com POST /api/hosting/v1/accounts/{username}/wordpress/{software}/content/images/generate.
Enquanto a geração ainda está em execução, apenas status: in-progress é retornado; consulte a cada
poucos segundos. Uma vez que completed, result contém o conteúdo gerado formatado de acordo com
type: URLs temporárias de imagens juntamente com o tempo de expiração para image-generation, ou
o documento do site gerado para website-generation (iniciado a partir do plugin WordPress
da Hostinger). Uma geração failed não tem result. IDs de geração desconhecidos ou expirados
retornam 404.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/content/generations/{generation_id}
wordpress_ai-tools_show-option-status
Mostra o status atual da opção de IA para o plugin Hostinger Tools na
instalação do WordPress especificada. Filtre por option para retornar uma única
opção, ou omita-o para retornar todas as opções.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/hostinger-plugins/ai-option/status
wordpress_ai-tools_set-option-status
Ativa ou desativa uma opção de IA para o plugin Hostinger Tools na instalação do WordPress especificada.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/hostinger-plugins/ai-option/status
wordpress_installations_check-if-are-valid
Verifica se uma ou mais instalações do WordPress são válidas e estão funcionando corretamente. Detecta instalações quebradas causadas por arquivos ausentes, plugins quebrados, temas e problemas semelhantes.
Forneça os identificadores da instalação do WordPress (software) no corpo. Eles
podem ser obtidos de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/installations/check-is-valid
wordpress_installations_delete
Exclui a instalação do WordPress especificada, com remoção opcional de arquivos e banco de dados. Isso remove todos os componentes associados, incluindo plugins, temas, sites de staging e quaisquer outros dados relacionados.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
DELETE - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}
wordpress_installations_detect
Dispara uma verificação em segundo plano para detectar instalações do WordPress para a conta.
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que a verificação foi enfileirada. Consulte GET /api/hosting/v1/wordpress/installations para buscar as instalações detectadas quando a verificação for concluída.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/installations/detect
wordpress_installations_import-website
Importa um site WordPress para o domínio especificado.
AVISO: isso sobrescreve o conteúdo existente do site e não pode ser desfeito — verifique se isso é intencional antes de chamar este endpoint.
Este endpoint permite importar um site WordPress a partir de arquivos de arquivo e banco de dados que foram enviados para o diretório do site.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/import
wordpress_installations_install
Instala o WordPress em um site existente.
O site deve existir antes de chamar este endpoint. Para criar um novo site primeiro, use POST /api/hosting/v1/websites e consulte GET /api/hosting/v1/websites até que ele apareça.
Chame GET /api/hosting/v1/wordpress/installations filtrado por nome de usuário e
domínio antes de prosseguir para verificar se o WordPress já está instalado no
domínio/caminho de destino. Se o WordPress já existir e overwrite for falso
(o padrão), o trabalho assíncrono falhará.
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de instalação foi enfileirado, não que o WordPress está pronto. A instalação normalmente leva de 1 a 2 minutos. Consulte GET /api/hosting/v1/wordpress/installations filtrado por nome de usuário e domínio para acompanhar o progresso. Quando a instalação aparecer nessa lista, o WordPress está pronto.
Retorna 422 quando a conta já usa todos os bancos de dados que seu plano permite,
a menos que database.name seja um banco de dados existente na conta.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/installations
wordpress_installations_list
Lista instalações do WordPress em contas de hospedagem web compartilhada e em nuvem (a
família /api/hosting/v1, identificada por username) acessíveis ao
cliente autenticado.
Os sites do Plano Agência não são incluídos. Para trabalhar com WordPress em um site do Plano Agência, liste-os com GET /api/agency-hosting/v1/websites?website_types=wordpress e leia seus detalhes com GET /api/agency-hosting/v1/websites/{website_uid}/wordpress/settings. Uma conta que só tem sites do Plano Agência recebe uma lista vazia deste endpoint.
Use este endpoint para descobrir instalações existentes do WordPress e para consultar o status da instalação após chamar o endpoint de instalação. Quando uma instalação recém-solicitada aparecer nesta lista, o WordPress está pronto. Filtre por nome de usuário e domínio para restringir os resultados a um site específico.
Cada instalação inclui um sinalizador valid e, quando inválida, um
validationError descrevendo o motivo.
- Método:
GET - Caminho:
/api/hosting/v1/wordpress/installations
wordpress_installations_list-core-updates
Lista as atualizações principais do WordPress disponíveis para a instalação especificada.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/updates
wordpress_installations_jwt-token
Retorna um token JWT usado para autenticar solicitações contra a instalação do WordPress especificada, incluindo seu endpoint MCP (Model Context Protocol).
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/jwt-token
wordpress_installations_show-core-version
Mostra a versão principal do WordPress para a instalação especificada, juntamente com vulnerabilidades conhecidas que a afetam.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/version
wordpress_installations_update-core
Atualiza o núcleo do WordPress para a instalação especificada (atualização menor ou uma versão específica).
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de atualização foi enfileirado.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/update
wordpress_litespeed-cache_purge-lite-speed
Limpa o cache LiteSpeed para a instalação do WordPress especificada.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/litespeed-cache/purge
wordpress_litespeed-cache_show-lite-speed-status
Mostra o status do cache LiteSpeed para a instalação do WordPress especificada.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/litespeed-cache/status
wordpress_login_create-links
Cria links temporários de login automático para a instalação do WordPress especificada.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/login/links
wordpress_maintenance_show-status
Mostra o status do modo de manutenção para a instalação do WordPress especificada.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/maintenance/status
wordpress_maintenance_toggle
Ativa ou desativa o modo de manutenção para a instalação do WordPress especificada,
com base no sinalizador enabled.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/maintenance/toggle
wordpress_object-cache_show-memcached-status
Mostra o status do cache de objetos Memcached para a instalação do WordPress especificada.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/memcached/status
wordpress_object-cache_toggle-memcached
Ativa ou desativa o cache de objetos Memcached para a instalação do WordPress
especificada, com base no sinalizador enabled.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
PATCH - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/memcached/toggle
wordpress_plugins_activate
Ativa um plugin instalado em uma instalação do WordPress.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de ativação foi enfileirado.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/activate
wordpress_plugins_deactivate
Desativa um plugin instalado em uma instalação do WordPress.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de desativação foi enfileirado.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/deactivate
wordpress_plugins_deploy
Implanta um plugin WordPress a partir de um diretório já enviado.
Este endpoint permite implantar um plugin WordPress que foi enviado para o diretório do site. O plugin será ativado e disponibilizado no painel administrativo do WordPress.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/plugins/deploy
wordpress_plugins_install
Instala um ou mais plugins em uma instalação existente do WordPress.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
Use GET /api/hosting/v1/wordpress/plugins para descobrir os slugs de plugins
disponíveis para instalação.
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de instalação foi enfileirado, não que os plugins estão prontos.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install
wordpress_plugins_list
Lista plugins recomendados para instalação em uma instalação do WordPress que ainda não estão instalados.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/available
wordpress_plugins_list-installed
Lista plugins instalados em uma instalação do WordPress, incluindo seu status, atualizações disponíveis e vulnerabilidades conhecidas.
Forneça o identificador da instalação do WordPress (software) no caminho. Ele pode
ser obtido de GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins
wordpress_plugins_search
Pesquisa o diretório de plugins do WordPress.org por plugins disponíveis para instalação.
Use os valores slug retornados com
POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install.
- Método:
GET - Caminho:
/api/hosting/v1/wordpress/plugins
wordpress_plugins_list-suggested
Lista sugestões de plugins selecionados, agrupadas por tipo de site.
Use os valores de slug retornados com
POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install.
- Método:
GET - Caminho:
/api/hosting/v1/wordpress/plugins/suggested
wordpress_plugins_check-if-woo-commerce-is-installed
Verifica se o WooCommerce está instalado em qualquer instalação WordPress de um domínio. Opcionalmente, filtre por domínio para limitar a verificação.
- Método:
GET - Caminho:
/api/hosting/v1/wordpress/plugins/is-woocommerce-installed
wordpress_plugins_uninstall
Desinstala um ou mais plugins de uma instalação WordPress.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido em GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de desinstalação foi colocado na fila.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/uninstall
wordpress_plugins_update-hostinger
Atualiza um plugin da Hostinger para sua versão mais recente em uma instalação WordPress.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido em GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de atualização foi colocado na fila.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/hostinger/update
wordpress_plugins_update
Atualiza um ou mais plugins instalados para suas versões mais recentes em uma instalação WordPress.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido em GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de atualização foi colocado na fila.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/update
wordpress_themes_activate
Ativa um tema instalado em uma instalação WordPress.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido em GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de ativação foi colocado na fila.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/activate
wordpress_themes_deploy
Implanta um tema WordPress a partir de um diretório já enviado.
Este endpoint permite implantar um tema WordPress que foi enviado para o diretório do site. O tema pode ser opcionalmente ativado após a implantação.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/websites/{domain}/wordpress/themes/deploy
wordpress_themes_install
Instala um tema em uma instalação WordPress existente.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido em GET /api/hosting/v1/wordpress/installations (o campo id).
Quando o tema é um dos temas da Hostinger (hostinger-blog,
hostinger-affiliate-theme, hostinger-ai-theme), os campos opcionais palette,
layout e font são encaminhados ao instalador personalizado (padrões:
palette1, layout1, default). Para qualquer outro tema, eles são ignorados.
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de instalação foi colocado na fila, não que o tema está pronto.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/install
wordpress_themes_list-installed
Lista temas instalados em uma instalação WordPress, incluindo seu status, atualizações disponíveis e vulnerabilidades conhecidas.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido em GET /api/hosting/v1/wordpress/installations (o campo id).
- Método:
GET - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes
wordpress_themes_list
Lista temas WordPress disponíveis para instalação.
Use os valores de slug retornados com
POST /api/hosting/v1/accounts/{username}/wordpress/{software}/themes/install.
- Método:
GET - Caminho:
/api/hosting/v1/wordpress/themes
wordpress_themes_uninstall
Desinstala um ou mais temas de uma instalação WordPress.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido em GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de desinstalação foi colocado na fila.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/uninstall
wordpress_themes_update
Atualiza um ou mais temas instalados para suas versões mais recentes em uma instalação WordPress.
Forneça o identificador da instalação WordPress (software) no caminho. Ele pode
ser obtido em GET /api/hosting/v1/wordpress/installations (o campo id).
Esta operação é assíncrona: uma resposta bem-sucedida significa apenas que o trabalho de atualização foi colocado na fila.
- Método:
POST - Caminho:
/api/hosting/v1/accounts/{username}/wordpress/{software}/themes/update