Parar Projeto

Pausa a execução do projeto.

PATCH /project/:id/stop

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

Resposta

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

Retomar Projeto

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

PATCH /project/:id/resume

Parâmetros de Path

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

Resposta

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

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