Logo ZenifraZenifra

Variáveis de Ambiente

Aprenda como gerenciar as variáveis de ambiente do seu projeto via API.

Obter Variáveis de Ambiente

Retorna as variáveis de ambiente configuradas no projeto.

GET /project/:id/envs

Parâmetros de Path

ParâmetroTipoDescrição
idstringID do projeto (ObjectId)

Resposta

{
  "status": "success",
  "data": {
    "envs": [
      {
        "name": "DATABASE_URL",
        "value": "postgres://user:pass@host:5432/db"
      },
      {
        "name": "NODE_ENV",
        "value": "production"
      }
    ]
  }
}

Atualizar Variáveis de Ambiente

Atualiza as variáveis de ambiente do projeto.

PATCH /project/:id/envs

Parâmetros de Path

ParâmetroTipoDescrição
idstringID do projeto (ObjectId)

Body

CampoTipoObrigatórioDescrição
envsarraySimArray de objetos com name e value (máximo 50 variáveis, cada nome máximo 120 caracteres, cada valor máximo 32760 caracteres)

Exemplo

{
  "envs": [
    {
      "name": "DATABASE_URL",
      "value": "postgres://user:pass@host:5432/db"
    },
    {
      "name": "API_KEY",
      "value": "nova-api-key"
    }
  ]
}

Resposta

{
  "status": "success",
  "message": "Environment variables updated"
}

Exemplos

Obter Variáveis de Ambiente

curl -X GET "https://api.zenifra.com/v1/project/507f1f77bcf86cd799439011/envs" \
  -H "x-api-key: sua-api-key"

Atualizar Variáveis de Ambiente

curl -X PATCH "https://api.zenifra.com/v1/project/507f1f77bcf86cd799439011/envs" \
  -H "x-api-key: sua-api-key" \
  -H "Content-Type: application/json" \
  -d '{"envs": [{"name": "NODE_ENV", "value": "production"}]}'

Python

import requests

API_KEY = "sua-api-key"
PROJECT_ID = "507f1f77bcf86cd799439011"

headers = {"x-api-key": API_KEY}

# Obter variáveis de ambiente
envs = requests.get(
    f"https://api.zenifra.com/v1/project/{PROJECT_ID}/envs",
    headers=headers
).json()
print(envs)

# Atualizar variáveis de ambiente
requests.patch(
    f"https://api.zenifra.com/v1/project/{PROJECT_ID}/envs",
    headers=headers,
    json={
        "envs": [
            {"name": "NODE_ENV", "value": "production"},
            {"name": "DATABASE_URL", "value": "postgres://user:pass@host:5432/db"}
        ]
    }
)

Limites

  • Máximo de 50 variáveis de ambiente por projeto
  • Cada nome pode ter até 120 caracteres
  • Cada valor pode ter até 32760 caracteres