Parar Projeto

Pausa a execução do projeto.

Permissões necessárias

Parar o projeto exige project.stop em project:<project-id>. Retomar exige project.resume no mesmo projeto. owner tem acesso completo; assistant, member e API Keys da organização precisam do scope da ação.

PATCH /v1/project/:id/stop

Parâmetros de Path

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

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

Resposta

{
  "status": "success",
  "message": "stopped project with success"
}

Erros

Status	Quando ocorre
`404`	Projeto não encontrado
`409`	Já existe uma parada em andamento para o projeto

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

Retomar Projeto

Retoma a execução de um projeto que está parado.

PATCH /v1/project/:id/resume

A retomada é assíncrona: a API aceita o pedido e o projeto passa para o status resuming até voltar a running. Consulte GET /v1/project/:id para acompanhar.

Parâmetros de Path

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

Resposta

{
  "status": "success",
  "message": "project resume accepted"
}

Erros

Status	Quando ocorre
`400`	O projeto já está em execução
`402`	A organização está bloqueada por cobrança pendente
`404`	Projeto não encontrado
`409`	A retomada já está em andamento, a capacidade solicitada está temporariamente indisponível (`INSUFFICIENT_PLAN_CAPACITY`) ou o limite de instâncias do plano Free foi atingido (`FREE_PLAN_INSTANCE_LIMIT_REACHED`)
`503`	A capacidade do projeto está temporariamente indisponível (`PLAN_CAPACITY_TEMPORARILY_UNAVAILABLE`); tente novamente em instantes

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

Exemplos

Parar Projeto

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

Retomar Projeto

curl -X PATCH "https://api.zenifra.com/v1/project/507f1f77bcf86cd799439011/resume" \
  -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}

# Parar projeto
stop_response = requests.patch(
    f"https://api.zenifra.com/v1/project/{PROJECT_ID}/stop",
    headers=headers
).json()
print(stop_response)

# Retomar projeto
resume_response = requests.patch(
    f"https://api.zenifra.com/v1/project/{PROJECT_ID}/resume",
    headers=headers
).json()
print(resume_response)

Casos de Uso

Manutenção: Pause o projeto durante manutenção programada
Economia: Pause projetos que não precisam estar rodando continuamente
Testes: Pause ambientes de teste quando não estiverem em uso

Nessa página