Obter Variáveis de Ambiente

Retorna as variáveis de ambiente configuradas no projeto.

GET /project/:id/envs

Parâmetros de Path

Parâmetro	Tipo	Descrição
`id`	string	ID do projeto (ObjectId)

Headers

Header	Obrigatório	Descrição
`x-api-key`	Sim	API Key do projeto
`x-organization-id`	Sim	Organização ativa do projeto
`Content-Type: application/json`	Condicional	Necessário apenas nas chamadas `PATCH`

Valores de variáveis de ambiente podem conter dados sensíveis. Trate esta resposta como sensível porque os valores retornados pela API podem estar disponíveis em texto claro para chamadas com uma API key válida do projeto.

{
  "status": "success",
  "message": "get envs with success",
  "data": [
    {
      "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âmetro	Tipo	Descrição
`id`	string	ID do projeto (ObjectId)

Body

Campo	Tipo	Obrigatório	Descrição
`envs`	array	Sim	Array 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": "updated with success"
}

Exemplos

Obter Variáveis de Ambiente

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

Atualizar Variáveis de Ambiente

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

Python

import requests

API_KEY = "sua-api-key"
ORGANIZATION_ID = "sua-organization-id"
PROJECT_ID = "507f1f77bcf86cd799439011"

headers = {"x-api-key": API_KEY, "x-organization-id": ORGANIZATION_ID}

# 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

Nessa Página