Desenvolvedores

Referência da API

Crie e gerencie sites via código.

A API da Droply permite criar sites e fazer deploy a partir dos seus próprios scripts e das integrações (a GPT Action do ChatGPT, o n8n, o VS Code e a extensão para Chrome usam essa mesma API). A especificação em formato de máquina fica em /api/v1/openapi.json (OpenAPI 3.1).

URL base

https://droply.host/api/v1

Autenticação

Crie um token de acesso pessoal no seu painel, em API tokens, e mande esse token como bearer token em toda requisição. O acesso à API exige um plano pago.

Authorization: Bearer YOUR_TOKEN

Para conferir um token a qualquer momento:

curl https://droply.host/api/v1/user \
  -H "Authorization: Bearer YOUR_TOKEN"

Os tokens criados na página API tokens têm Full access (acesso total), que é o necessário para alterar as configurações de um site, excluir um site, publicar um rascunho e voltar uma versão. Já os tokens só de deploy que as extensões do navegador e do editor criam quando você entra por elas podem criar sites e fazer deploy, e nada além disso.

Criar um site

Reserva um subdomínio, servido em <subdomain>.droply.id. Se você não mandar subdomain, a Droply escolhe um livre.

curl -X POST https://droply.host/api/v1/sites \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"subdomain":"my-portfolio","name":"My Portfolio"}'

Encontrar um site

Os ids de site e de deploy são UUIDs. Para achar o id de um site sem percorrer a lista inteira, filtre pelo subdomínio ou pelo endereço que o visitante digita (o endereço na Droply ou um domínio próprio conectado):

curl "https://droply.host/api/v1/sites?subdomain=my-portfolio" \
  -H "Authorization: Bearer YOUR_TOKEN"

curl "https://droply.host/api/v1/sites?host=www.example.com" \
  -H "Authorization: Bearer YOUR_TOKEN"

Deploy

Envie um arquivo (um HTML, o ZIP de um site estático, um PDF ou uma imagem) ou mande o HTML direto. A extensão do arquivo define como ele é servido, então mande o nome real. O processamento é assíncrono: a chamada responde 202 com um deploy que você pode consultar até ficar pronto.

# Enviar o ZIP de um site estático
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "[email protected]"

# …ou publicar o HTML direto (até 12 MB; uma página maior vai como arquivo)
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"html":"<!doctype html><h1>Hello</h1>"}'

Consultar o status do deploy

Consulte até o status virar live (aí a resposta já traz o live_url) ou failed (veja o motivo em error_message).

curl https://droply.host/api/v1/deployments/DEPLOYMENT_ID \
  -H "Authorization: Bearer YOUR_TOKEN"

Rascunhos, publicação e rollback

Acrescente draft a um deploy para salvar a versão sem colocá-la no ar: ela é processada e verificada, e fica esperando como staged enquanto o site continua servindo o que já servia. Publique quando quiser, ou coloque uma versão anterior no ar de novo. As duas chamadas respondem 202 enquanto a mudança está na fila; consulte o deploy até ele ficar live.

# Salvar um rascunho (o multipart manda draft=1)
curl -X POST https://droply.host/api/v1/sites/SITE_ID/deployments \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -F "[email protected]" -F "draft=1"

# Publicar o rascunho
curl -X POST https://droply.host/api/v1/deployments/DEPLOYMENT_ID/publish \
  -H "Authorization: Bearer YOUR_TOKEN"

# Voltar para uma versão anterior (qualquer deploy já substituído)
curl -X POST https://droply.host/api/v1/deployments/DEPLOYMENT_ID/rollback \
  -H "Authorization: Bearer YOUR_TOKEN"

Senha e expiração automática

Só muda o que você mandar. password_protected: false remove a senha; expires_at recebe data e hora no formato ISO 8601 com o fuso, ou null para tirar o prazo.

curl -X PATCH https://droply.host/api/v1/sites/SITE_ID \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"password":"s3cret-preview","expires_at":"2026-12-01T18:00:00Z"}'

Endpoints

  • GET /user: a conta autenticada e o plano dela
  • GET /sites: lista os seus sites (filtre com subdomain ou host)
  • POST /sites: cria um site
  • GET /sites/check?subdomain=: diz se um subdomínio está livre
  • GET /sites/{site}: retorna um site
  • PATCH /sites/{site}: altera o nome, a senha ou a expiração automática (Full access)
  • DELETE /sites/{site}: exclui um site (Full access). Um site num espaço protegido contra exclusão acidental só pode ser excluído pelo painel. Um site que foi tirado do ar, ou que tem uma versão retida para verificação de segurança, responde 409.
  • POST /sites/{site}/deployments: faz um deploy (arquivo ou html, com opção de rascunho)
  • GET /sites/{site}/deployments: lista os deploys de um site
  • GET /deployments/{deployment}: status do deploy
  • POST /deployments/{deployment}/retry: tenta de novo um deploy que falhou
  • POST /deployments/{deployment}/publish: publica um rascunho (Full access)
  • POST /deployments/{deployment}/rollback: coloca uma versão anterior no ar (Full access)

Erros e limites

  • 401: token ausente ou inválido.
  • 403: o seu plano não inclui acesso à API ou esse recurso, ou o token não tem permissão para essa ação (algumas ações exigem um token com Full access).
  • 404: o recurso não existe ou não é seu.
  • 409: a ação não vale para essa versão (por exemplo, publicar uma versão que não é rascunho).
  • 413: o envio passa do tamanho máximo de uma requisição (100 MB).
  • 422: a validação falhou (um objeto errors lista os campos).
  • 429: limite de requisições excedido. O limite é por token, e publicar rascunhos e voltar versões tem um teto de 30 por hora por conta. Espere os segundos indicados no header Retry-After.

Mais documentação