Skip to main content
As variáveis de ambiente são configuradas por aplicação nas rotas REST /v1/apps/:id/envs da API v1. As operações de escrita salvam a configuração; elas não reiniciam a aplicação automaticamente. Para aplicar valores atualizados, chame sonder.apps.restart(appId) ou a rota POST /v1/apps/:id/restart.
GET /v1/apps/:id/envs e as respostas de escrita retornam valores sem mascaramento, inclusive segredos. Proteja o token de API e evite registrar ou exibir essas respostas em logs, interfaces públicas ou ferramentas de observabilidade.

Operações

As requisições exigem Authorization: Bearer <token> e um appId em formato UUID v4. Para detalhes por operação, consulte GET, POST, PATCH, PUT e DELETE.

Consultar

Resposta:

Adicionar ou atualizar

Envie apenas as chaves que deseja criar ou alterar. As demais permanecem salvas.

Substituir o conjunto completo

O corpo representa o conjunto desejado inteiro. Chaves que existiam, mas foram omitidas, são removidas.

Remover chaves

O corpo deve conter um array keys não vazio.

Formato e limites

  • São permitidas até 256 variáveis por aplicação.
  • O nome deve ter até 128 caracteres e seguir o padrão [A-Za-z_][A-Za-z0-9_]* (por exemplo, API_KEY ou _INTERNAL).
  • O valor deve ser uma string de até 4096 caracteres. Para representar um valor vazio, envie ""; números e booleanos devem ser convertidos para strings.
  • Não é possível alterar variáveis enquanto o app está em BUILDING; a API responde com 400 Bad Request.
  • As respostas de escrita incluem success: true, response com o mapa atualizado de variáveis e a mensagem Environment variables saved. Restart the app to apply changes.. Falhas retornam success: false e message, com o status HTTP correspondente. Trate response como dado secreto.

Aplicar as alterações

Depois de salvar as variáveis, reinicie a aplicação:
O start e o restart usam o conjunto de variáveis salvo. Para uma aplicação parada, sonder.apps.start(appId) também inicia o container com os valores atuais.