Histórico de Deployments

Use este endpoint para listar os deployments registrados para um projeto no mês atual. Ele ajuda a auditar alterações, confirmar se uma atualização de imagem gerou histórico e montar painéis simples de atividade.

Endpoint

GET /v1/project/:id/historic/deployments

Limite de requisições: 100 por minuto (contado por IP de origem).

Headers

Header	Obrigatório	Descrição
`x-api-key` ou `Authorization`	Sim	API Key da organização ou token de usuário
`x-organization-id`	Com token de usuário	Organização ativa do projeto. Dispensável com API Key da organização

Parâmetros de Path

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

Janela de Consulta

A API retorna deployments criados entre o início e o fim do mês atual, considerando o horário do servidor. Não há parâmetros públicos para mudar essa janela nesta rota.

Permissões necessárias

Consultar o histórico exige project.read em project:<project-id>. owner tem acesso completo; assistant, member e API Keys precisam do grant correspondente.

Resposta

{
  "status": "success",
  "message": "get deployments with success",
  "data": [
    {
      "id": "665f1f77bcf86cd799439011",
      "updated_image": true,
      "created_at": "2026-05-23T14:10:00.000Z"
    }
  ]
}

Como Interpretar

Campo	Descrição
`id`	Identificador do registro de deployment
`updated_image`	`true` quando o evento foi uma nova imagem; `false` em alterações de variáveis de ambiente ou de domínios personalizados
`created_at`	Data de criação do evento

Exemplos

curl

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

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}

deployments = requests.get(
    f"https://api.zenifra.com/v1/project/{PROJECT_ID}/historic/deployments",
    headers=headers
).json()

print(deployments)

Node.js

const axios = require('axios');

const API_KEY = 'sua-api-key';
const ORGANIZATION_ID = 'sua-organization-id';
const PROJECT_ID = '507f1f77bcf86cd799439011';

axios.get(
  `https://api.zenifra.com/v1/project/${PROJECT_ID}/historic/deployments`,
  { headers: { 'x-api-key': API_KEY, 'x-organization-id': ORGANIZATION_ID } }
).then((response) => console.log(response.data));

Erros Comuns

Código	Motivo provável	Como resolver
`401`	Header de autenticação ausente	Envie `x-api-key`
`403`	Organização ou permissão inválida	Confirme `x-organization-id` e acesso ao projeto
`404`	Projeto não encontrado	Confira `Project ID`, API Key e organização
`500`	Falha ao buscar histórico	Tente novamente ou acione o suporte

Próximos Passos

Use Atualizar Imagem de Deploy para iniciar um novo deploy por imagem.
Consulte Informações do Projeto para ver o status atual.
Veja Métricas e Logs após um deployment.

Nessa página