CronLume
API PROFISSIONAL CRONLUME · V1

Construir, operar e recuperar
Cada cron by API.

Consola completa de referência e teste ao vivo para operações de cron profissional. Conecte uma chave API dedicada, edite parâmetros reais e inspecione a resposta exata retornada pelo seu espaço de trabalho CronLume.

25 operações documentadasJSON organismos de pedido e de respostaPortador autenticação
URL da BASE DE PRODUÇÃOhttps://api.cronlume.com/v1CABEÇA DE AUTENTICAÇÃOAuthorization: Bearer crl_live_…

Chaves são criadas e revogadas sob Painel → teclas API.

⌁
CONSOLE DA API AO VIVO

Conecte sua chave de API

A chave permanece na memória desta página e é enviada apenas para o ponto final que você testa explicitamente. Ele nunca é adicionado a exemplos, URLs ou armazenamento de navegador.

Não conectado
DOMAIN API

autenticação

Verifique credenciais e identifique o espaço de trabalho ativo.

GET/account

Verificar a ligação à API

Validar a chave do portador e retornar a identidade e espaço de trabalho autenticado da chave API. O console interativo usa este endpoint quando o Connect é selecionado.

PermissãoQualquer chave de API ativa

Pedido de exemplo

curl -X GET "https://api.cronlume.com/v1/account" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": {
        "workspace": {
            "id": "81f9349b-8fd2-41ed-816a-4c673603b951",
            "name": "Acme Operations",
            "plan": "professional"
        },
        "api_key": {
            "id": "1cf3ef95-65c9-44d3-90e2-c473c0ff7a39",
            "name": "Production automation",
            "prefix": "crl_live_a8f94d",
            "last_used_at": "2026-08-28 20:08:31.000000"
        },
        "user": {
            "id": "f6e4f785-cbbe-45db-b179-467dcf61337d",
            "name": "Alex Morgan",
            "email": "alex@example.com"
        }
    }
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
DOMAIN API

Trabalhos do Cron

Criar, inspecionar, programar e controlar operações de Cron HTTP.

GET/crons

Listar e pesquisar trabalhos de cron

Retorna trabalhos ordenados por urgência operacional. Combine filtros para localizar um projeto, estado incidente ou endpoint rapidamente.

PermissãoQualquer chave de API

Campos de solicitação

Parâmetros da consulta
searchstringOpcional

Procurar título, URL e descrição.

Exemplo: invoices
statusenumOpcional

pendente, saudável, degradado, para baixo ou em pausa.

Exemplo: down
activebooleanoOpcional

Filtrar tarefas activas ou desactivadas.

Exemplo: true
group_idUUIDOpcional

Filtrar por projeto/grupo local.

category_idUUIDOpcional

Filtrar por categoria.

limitinteiroOpcional

1-100. Predefinição para 50.

Exemplo: 50
offsetinteiroOpcional

Deslocamento da paginação. O padrão é 0.

Exemplo: 0

Pedido de exemplo

curl -X GET "https://api.cronlume.com/v1/crons?search=invoices&status=down&active=true&group_id=&category_id=&limit=50&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": [
        {
            "id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
            "name": "Generate customer invoices",
            "description": "Creates invoices for completed billing periods.",
            "criticality": "critical",
            "url": "https://billing.example.com/tasks/invoices",
            "method": "POST",
            "cron_expression": "*/15 * * * *",
            "timezone": "Europe/Brussels",
            "timeout_seconds": 180,
            "failure_threshold": 3,
            "failure_action_enabled": true,
            "failure_action_threshold": 3,
            "failure_action_url": "https://backup.example.com/recover/invoices",
            "is_active": true,
            "current_status": "healthy",
            "next_run_at": "2026-08-28 20:15:00.000000",
            "last_run_at": "2026-08-28 20:00:00.000000",
            "consecutive_failures": 0,
            "group_name": "Billing platform",
            "category_ids": [
                "125976d5-c276-481c-984c-a9b4b70e477e"
            ]
        }
    ],
    "pagination": {
        "total": 1,
        "limit": 50,
        "offset": 0
    }
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
POSTO/crons

Criar uma tarefa de cron

Crie um cronograma HTTP totalmente monitorado. Os campos necessários são intencionalmente mínimos; cada salvaguarda operacional pode ser configurada na mesma solicitação.

PermissãoChave API habilitada para gravação

Campos de solicitação

Corpo JSON
namestringRequerido

Título legível pelo homem usado em busca, alertas e timelines de incidentes.

Exemplo: Generate customer invoices
urlURLRequerido

Endpoint HTTP ou HTTPS chamado pelo trabalhador de execução. Nunca coloque credenciais no URL.

Exemplo: https://billing.example.com/tasks/invoices
cron_expressionstringRequerido

Expressão padrão de crontab de cinco campos: minuto, hora, dia do mês, mês e dia da semana.

Exemplo: */15 * * * *
descriptionstringOpcional

Objetivo operacional e contexto seguro para os respondedores. Máximo 600 caracteres.

Exemplo: Creates invoices for completed billing periods.
criticalityenumOpcional

padrão, importante ou crítico. O padrão é importante.

Exemplo: critical
methodenumOpcional

Pega, põe, bate, deleta ou cabeça. Padrões para obter.

Exemplo: POST
headersobjetoOpcional

Cabeçalhos de requisição HTTP. Armazenado encriptado. Não os inclua em pedidos de apoio.

Exemplo: {"Authorization":"Bearer service-token"}
bodystringOpcional

Corpo de solicitação HTTP bruto enviado para o endpoint.

Exemplo: {"source":"cronlume"}
group_idUUID onullOpcional

Grupo existente no mesmo espaço de trabalho.

category_idsUUID[]Opcional

Identificadores de categoria existentes no mesmo espaço de trabalho.

Exemplo: []
timezoneFuso horário da IANAOpcional

Fuso- horário usado para avaliar a expressão de cron. O padrão é UTC.

Exemplo: Europe/Brussels
timeout_secondsinteiroOpcional

Duração máxima do pedido. Os objetivos de longo prazo são suportados. O padrão é 120.

Exemplo: 180
connect_timeout_secondsinteiroOpcional

Tempo máximo de instalação da ligação. O padrão é 15.

Exemplo: 20
follow_redirectsbooleanoOpcional

Siga redirecionamentos HTTP. O padrão é verdadeiro.

Exemplo: 1
verify_tlsbooleanoOpcional

Verifique o certificado remoto TLS. Manter activada na produção.

Exemplo: 1
expected_status_mininteiroOpcional

O estado HTTP mais baixo foi considerado bem sucedido. O padrão é 200.

Exemplo: 200
expected_status_maxinteiroOpcional

O status HTTP mais alto considerado bem sucedido. O padrão é 399.

Exemplo: 399
max_retriesinteiroOpcional

Tentativas adicionais após uma solicitação falhada. Predefinição para 2.

Exemplo: 2
retry_backoff_secondsinteiroOpcional

Atraso entre tentativas de repetição. O padrão é 30.

Exemplo: 30
failure_thresholdinteiroOpcional

As execuções consecutivas falharam antes da tarefa ser considerada para baixo. Predefinição para 2.

Exemplo: 3
recovery_thresholdinteiroOpcional

Sucessos consecutivos necessários para resolver um incidente. Predefinição para 1.

Exemplo: 1
alert_repeat_minutesinteiroOpcional

Intervalo de repetição para alertas de incidentes persistentes. O padrão é 15.

Exemplo: 15
grace_secondsinteiroOpcional

Scheduling período de graça antes de uma execução perdida é considerado tarde. O padrão é 60.

Exemplo: 60
alert_on_pausebooleanoOpcional

Enviar alertas quando o trabalho é automaticamente ou manualmente desativado. O padrão é verdadeiro.

Exemplo: 1
failure_action_enabledbooleanoOpcional

Chame uma URL de emergência quando a sequência de falhas configurada for alcançada.

Exemplo: 1
failure_action_thresholdinteiroOpcional

Contagem de falhas que ativa o URL de emergência. Distância 1–20.

Exemplo: 3
failure_action_urlURL ́nullOpcional

URL HTTP( S) de emergência. Deve diferir da URL primária.

Exemplo: https://backup.example.com/recover/invoices
is_activebooleanoOpcional

Crie o trabalho ativo ou pausado. O padrão é verdadeiro.

Exemplo: 1

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/crons" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Generate customer invoices",
    "url": "https://billing.example.com/tasks/invoices",
    "cron_expression": "*/15 * * * *",
    "timezone": "Europe/Brussels",
    "method": "POST",
    "timeout_seconds": 180,
    "criticality": "critical",
    "failure_threshold": 3,
    "alert_on_pause": true,
    "failure_action_enabled": true,
    "failure_action_threshold": 3,
    "failure_action_url": "https://backup.example.com/recover/invoices"
}'

Resposta do exemplo

201
{
    "data": {
        "id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
        "name": "Generate customer invoices",
        "description": "Creates invoices for completed billing periods.",
        "criticality": "critical",
        "url": "https://billing.example.com/tasks/invoices",
        "method": "POST",
        "cron_expression": "*/15 * * * *",
        "timezone": "Europe/Brussels",
        "timeout_seconds": 180,
        "failure_threshold": 3,
        "failure_action_enabled": true,
        "failure_action_threshold": 3,
        "failure_action_url": "https://backup.example.com/recover/invoices",
        "is_active": true,
        "current_status": "healthy",
        "next_run_at": "2026-08-28 20:15:00.000000",
        "last_run_at": "2026-08-28 20:00:00.000000",
        "consecutive_failures": 0,
        "group_name": "Billing platform",
        "category_ids": [
            "125976d5-c276-481c-984c-a9b4b70e477e"
        ]
    }
}

Respostas possíveis

201Trabalho do Cron criado
401Chave API inválida
422Campo em falta, expressão de cron inválido ou URL de emergência inválido
Preparando o formulário de teste interativo...
GET/crons/{cron_id}

Recuperar uma tarefa do cron

Retornar configuração completa e estado operacional atual, incluindo cabeçalhos de pedidos descriptografados para uso de engenharia autorizado. Trate a resposta como sensível.

PermissãoQualquer chave de API

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador da tarefa do Cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821

Pedido de exemplo

curl -X GET "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": {
        "id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
        "name": "Generate customer invoices",
        "description": "Creates invoices for completed billing periods.",
        "criticality": "critical",
        "url": "https://billing.example.com/tasks/invoices",
        "method": "POST",
        "cron_expression": "*/15 * * * *",
        "timezone": "Europe/Brussels",
        "timeout_seconds": 180,
        "failure_threshold": 3,
        "failure_action_enabled": true,
        "failure_action_threshold": 3,
        "failure_action_url": "https://backup.example.com/recover/invoices",
        "is_active": true,
        "current_status": "healthy",
        "next_run_at": "2026-08-28 20:15:00.000000",
        "last_run_at": "2026-08-28 20:00:00.000000",
        "consecutive_failures": 0,
        "group_name": "Billing platform",
        "category_ids": [
            "125976d5-c276-481c-984c-a9b4b70e477e"
        ]
    }
}

Respostas possíveis

200Trabalho do Cron retornado
401Chave API inválida
404Trabalho do Cron não encontrado neste espaço de trabalho
Preparando o formulário de teste interativo...
PATCH/crons/{cron_id}

Mudar a configuração do cron

Atualizar um ou mais campos suportados. Campos omitidos mantêm seus valores atuais. A alteração do calendário ou fuso- horário recalcula next run at.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador da tarefa do Cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821
Corpo JSON
namestringOpcional

Título legível pelo homem usado em busca, alertas e timelines de incidentes.

Exemplo: Generate customer invoices
urlURLOpcional

Endpoint HTTP ou HTTPS chamado pelo trabalhador de execução. Nunca coloque credenciais no URL.

Exemplo: https://billing.example.com/tasks/invoices
cron_expressionstringOpcional

Expressão padrão de crontab de cinco campos: minuto, hora, dia do mês, mês e dia da semana.

Exemplo: */15 * * * *
descriptionstringOpcional

Objetivo operacional e contexto seguro para os respondedores. Máximo 600 caracteres.

Exemplo: Creates invoices for completed billing periods.
criticalityenumOpcional

padrão, importante ou crítico. O padrão é importante.

Exemplo: critical
methodenumOpcional

Pega, põe, bate, deleta ou cabeça. Padrões para obter.

Exemplo: POST
headersobjetoOpcional

Cabeçalhos de requisição HTTP. Armazenado encriptado. Não os inclua em pedidos de apoio.

Exemplo: {"Authorization":"Bearer service-token"}
bodystringOpcional

Corpo de solicitação HTTP bruto enviado para o endpoint.

Exemplo: {"source":"cronlume"}
group_idUUID onullOpcional

Grupo existente no mesmo espaço de trabalho.

category_idsUUID[]Opcional

Identificadores de categoria existentes no mesmo espaço de trabalho.

Exemplo: []
timezoneFuso horário da IANAOpcional

Fuso- horário usado para avaliar a expressão de cron. O padrão é UTC.

Exemplo: Europe/Brussels
timeout_secondsinteiroOpcional

Duração máxima do pedido. Os objetivos de longo prazo são suportados. O padrão é 120.

Exemplo: 180
connect_timeout_secondsinteiroOpcional

Tempo máximo de instalação da ligação. O padrão é 15.

Exemplo: 20
follow_redirectsbooleanoOpcional

Siga redirecionamentos HTTP. O padrão é verdadeiro.

Exemplo: 1
verify_tlsbooleanoOpcional

Verifique o certificado remoto TLS. Manter activada na produção.

Exemplo: 1
expected_status_mininteiroOpcional

O estado HTTP mais baixo foi considerado bem sucedido. O padrão é 200.

Exemplo: 200
expected_status_maxinteiroOpcional

O status HTTP mais alto considerado bem sucedido. O padrão é 399.

Exemplo: 399
max_retriesinteiroOpcional

Tentativas adicionais após uma solicitação falhada. Predefinição para 2.

Exemplo: 2
retry_backoff_secondsinteiroOpcional

Atraso entre tentativas de repetição. O padrão é 30.

Exemplo: 30
failure_thresholdinteiroOpcional

As execuções consecutivas falharam antes da tarefa ser considerada para baixo. Predefinição para 2.

Exemplo: 3
recovery_thresholdinteiroOpcional

Sucessos consecutivos necessários para resolver um incidente. Predefinição para 1.

Exemplo: 1
alert_repeat_minutesinteiroOpcional

Intervalo de repetição para alertas de incidentes persistentes. O padrão é 15.

Exemplo: 15
grace_secondsinteiroOpcional

Scheduling período de graça antes de uma execução perdida é considerado tarde. O padrão é 60.

Exemplo: 60
alert_on_pausebooleanoOpcional

Enviar alertas quando o trabalho é automaticamente ou manualmente desativado. O padrão é verdadeiro.

Exemplo: 1
failure_action_enabledbooleanoOpcional

Chame uma URL de emergência quando a sequência de falhas configurada for alcançada.

Exemplo: 1
failure_action_thresholdinteiroOpcional

Contagem de falhas que ativa o URL de emergência. Distância 1–20.

Exemplo: 3
failure_action_urlURL ́nullOpcional

URL HTTP( S) de emergência. Deve diferir da URL primária.

Exemplo: https://backup.example.com/recover/invoices
is_activebooleanoOpcional

Crie o trabalho ativo ou pausado. O padrão é verdadeiro.

Exemplo: 1

Pedido de exemplo

curl -X PATCH "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "cron_expression": "0 */2 * * *",
    "timeout_seconds": 240,
    "failure_threshold": 4
}'

Resposta do exemplo

200
{
    "data": {
        "id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
        "name": "Generate customer invoices",
        "description": "Creates invoices for completed billing periods.",
        "criticality": "critical",
        "url": "https://billing.example.com/tasks/invoices",
        "method": "POST",
        "cron_expression": "0 */2 * * *",
        "timezone": "Europe/Brussels",
        "timeout_seconds": 240,
        "failure_threshold": 4,
        "failure_action_enabled": true,
        "failure_action_threshold": 3,
        "failure_action_url": "https://backup.example.com/recover/invoices",
        "is_active": true,
        "current_status": "healthy",
        "next_run_at": "2026-08-28 20:15:00.000000",
        "last_run_at": "2026-08-28 20:00:00.000000",
        "consecutive_failures": 0,
        "group_name": "Billing platform",
        "category_ids": [
            "125976d5-c276-481c-984c-a9b4b70e477e"
        ]
    }
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
DELETE/crons/{cron_id}

Apagar permanentemente uma tarefa do cron

Apagar o trabalho e o seu histórico de execução. Esta operação é permanente e não devolve nenhum corpo de resposta.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador da tarefa do Cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821

Pedido de exemplo

curl -X DELETE "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

204
No response body

Respostas possíveis

204Trabalho do Cron e histórico relacionado excluído
401Chave API inválida
404Trabalho do Cron não encontrado
Preparando o formulário de teste interativo...
POSTO/crons/{cron_id}/activate

Activar ou reativar um cron

Limpa a data e a razão da pausa, reinicia os bloqueios e calcula a próxima execução.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador da tarefa do Cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821/activate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": {
        "id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
        "name": "Generate customer invoices",
        "description": "Creates invoices for completed billing periods.",
        "criticality": "critical",
        "url": "https://billing.example.com/tasks/invoices",
        "method": "POST",
        "cron_expression": "*/15 * * * *",
        "timezone": "Europe/Brussels",
        "timeout_seconds": 180,
        "failure_threshold": 3,
        "failure_action_enabled": true,
        "failure_action_threshold": 3,
        "failure_action_url": "https://backup.example.com/recover/invoices",
        "is_active": true,
        "current_status": "pending",
        "next_run_at": "2026-08-28 20:15:00.000000",
        "last_run_at": "2026-08-28 20:00:00.000000",
        "consecutive_failures": 0,
        "group_name": "Billing platform",
        "category_ids": [
            "125976d5-c276-481c-984c-a9b4b70e477e"
        ]
    }
}

Respostas possíveis

200O estado do Cron foi alterado
401Chave API inválida
404Trabalho do Cron não encontrado
Preparando o formulário de teste interativo...
POSTO/crons/{cron_id}/deactivate

Desactivar um cron

Para futuras execuções e registra o horário exato da pausa UTC e a razão API.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador da tarefa do Cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821/deactivate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": {
        "id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
        "name": "Generate customer invoices",
        "description": "Creates invoices for completed billing periods.",
        "criticality": "critical",
        "url": "https://billing.example.com/tasks/invoices",
        "method": "POST",
        "cron_expression": "*/15 * * * *",
        "timezone": "Europe/Brussels",
        "timeout_seconds": 180,
        "failure_threshold": 3,
        "failure_action_enabled": true,
        "failure_action_threshold": 3,
        "failure_action_url": "https://backup.example.com/recover/invoices",
        "is_active": false,
        "current_status": "paused",
        "next_run_at": "2026-08-28 20:15:00.000000",
        "last_run_at": "2026-08-28 20:00:00.000000",
        "consecutive_failures": 0,
        "group_name": "Billing platform",
        "category_ids": [
            "125976d5-c276-481c-984c-a9b4b70e477e"
        ]
    }
}

Respostas possíveis

200O estado do Cron foi alterado
401Chave API inválida
404Trabalho do Cron não encontrado
Preparando o formulário de teste interativo...
POSTO/crons/{cron_id}/run

Colocar em fila uma execução imediata

Move next run at para a hora atual do UTC. O agendador aceita o trabalho assíncrono.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador da tarefa do Cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821/run" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

202
{
    "accepted": true,
    "cron_id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821"
}

Respostas possíveis

202Execução em fila
409O Cron está inactivo; reactiva- o primeiro
401Chave API inválida
404Trabalho do Cron não encontrado
Preparando o formulário de teste interativo...
POSTO/crons/bulk-activate

Reactivar múltiplas tarefas de cron

Reactivar as tarefas desactivadas seleccionadas após uma falha no servidor ou um incidente resolvido. Identificadores desconhecidos ou já ativos são ignorados.

PermissãoChave API habilitada para gravação

Campos de solicitação

Corpo JSON
job_idsUUID[]Requerido

Identificadores cron exclusivos para reativar. Massa máxima recomendada: 200.

Exemplo: ["a870d9ac-3a0f-49bb-b8e2-5f392fffc821"]

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/crons/bulk-activate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "job_ids": [
        "a870d9ac-3a0f-49bb-b8e2-5f392fffc821"
    ]
}'

Resposta do exemplo

200
{
    "data": {
        "reactivated_ids": [
            "a870d9ac-3a0f-49bb-b8e2-5f392fffc821"
        ],
        "reactivated_count": 1,
        "ignored_count": 0
    }
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
POSTO/crons/{cron_id}/duplicate

Duplicar um cron com segurança

Crie uma cópia operacional exata, incluindo categorias, canais de alerta, cabeçalhos criptografados e corpo de solicitação. A cópia é sempre pausada e claramente nomeada para que possa ser revisada antes da ativação sem causar uma execução dupla.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador de trabalho de código cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821/duplicate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

201
{
    "data": {
        "id": "44079c1f-a0eb-45f0-b998-0c81017b2cc2",
        "name": "Generate customer invoices (copy)",
        "description": "Creates invoices for completed billing periods.",
        "criticality": "critical",
        "url": "https://billing.example.com/tasks/invoices",
        "method": "POST",
        "cron_expression": "*/15 * * * *",
        "timezone": "Europe/Brussels",
        "timeout_seconds": 180,
        "failure_threshold": 3,
        "failure_action_enabled": true,
        "failure_action_threshold": 3,
        "failure_action_url": "https://backup.example.com/recover/invoices",
        "is_active": false,
        "current_status": "paused",
        "next_run_at": "2026-08-28 20:15:00.000000",
        "last_run_at": "2026-08-28 20:00:00.000000",
        "consecutive_failures": 0,
        "group_name": "Billing platform",
        "category_ids": [
            "125976d5-c276-481c-984c-a9b4b70e477e"
        ],
        "paused_at": "2026-08-29 14:22:00.000000",
        "pause_reason": "Duplicated safely through developer API \u2014 review before activation"
    }
}

Respostas possíveis

201duplicado em pausa criado
401Chave API inválida
404A tarefa de código cron não foi encontrada
Preparando o formulário de teste interativo...
POSTO/crons/bulk-pause

Pausar múltiplas tarefas de cron

Pause até 200 trabalhos ativos em uma operação. CronLume registra o tempo de pausa UTC exato e uma razão desenvolvedor-API em cada trabalho afetado. Identificadores desconhecidos, inacessíveis e já pausados são reportados como ignorados.

PermissãoChave API habilitada para gravação

Campos de solicitação

Corpo JSON
job_idsUUID[]Requerido

Identificadores cron exclusivos a pausar. Máximo 200.

Exemplo: ["a870d9ac-3a0f-49bb-b8e2-5f392fffc821"]

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/crons/bulk-pause" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "job_ids": [
        "a870d9ac-3a0f-49bb-b8e2-5f392fffc821"
    ]
}'

Resposta do exemplo

200
{
    "data": {
        "paused_ids": [
            "a870d9ac-3a0f-49bb-b8e2-5f392fffc821"
        ],
        "paused_count": 1,
        "ignored_count": 0
    }
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
POSTO/crons/bulk-move

Mover várias tarefas de cron para um grupo

Mova até 200 trabalhos para um projeto, site, serviço ou grupo de clientes. Enviar group id como null para tornar os trabalhos selecionados desgrupos. Só podem ser utilizados trabalhos e grupos do espaço de trabalho autenticado.

PermissãoChave API habilitada para gravação

Campos de solicitação

Corpo JSON
job_idsUUID[]Requerido

Identificadores cron exclusivos para mover. Máximo 200.

Exemplo: ["a870d9ac-3a0f-49bb-b8e2-5f392fffc821"]
group_idUUID onullRequerido

Identificador do grupo de destino, ou nulo para Ungrouped.

Exemplo: 6ef63789-baf1-44fc-99bb-0c5ce2d37a8b

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/crons/bulk-move" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "job_ids": [
        "a870d9ac-3a0f-49bb-b8e2-5f392fffc821"
    ],
    "group_id": "6ef63789-baf1-44fc-99bb-0c5ce2d37a8b"
}'

Resposta do exemplo

200
{
    "data": {
        "moved_ids": [
            "a870d9ac-3a0f-49bb-b8e2-5f392fffc821"
        ],
        "moved_count": 1,
        "ignored_count": 0,
        "group_id": "6ef63789-baf1-44fc-99bb-0c5ce2d37a8b"
    }
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
DOMAIN API

Execução

Investigue o timing, os resultados HTTP, as tentativas e as ações de emergência.

GET/crons/{cron_id}/executions

Listar o histórico de execução

Inspecione tempo de resposta, status HTTP, repetições e evidência de resposta segura para um único cron. A execução mais recente é devolvida primeiro.

PermissãoQualquer chave de API

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador da tarefa do Cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821
Parâmetros da consulta
limitinteiroOpcional

1–200. Predefinição para 50.

Exemplo: 50

Pedido de exemplo

curl -X GET "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821/executions?limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": [
        {
            "id": 18492,
            "job_id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
            "scheduled_at": "2026-08-28 20:00:00.000000",
            "started_at": "2026-08-28 20:00:00.143000",
            "finished_at": "2026-08-28 20:00:01.381000",
            "duration_ms": 1238,
            "status": "succeeded",
            "attempt": 1,
            "http_status": 200,
            "error_type": null,
            "error_message": null,
            "response_excerpt": "{\"processed\":42}",
            "worker_id": "scheduler-eu-01"
        }
    ]
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
GET/crons/{cron_id}/failure-actions

Listar execuções de acção de emergência

Inspecione cada invocação de URL de recuperação desencadeada por uma regra de falha consecutiva.

PermissãoQualquer chave de API

Campos de solicitação

Parâmetros do caminho
cron_idLocalização do UUIDRequerido

Identificador da tarefa do Cron.

Exemplo: a870d9ac-3a0f-49bb-b8e2-5f392fffc821
Parâmetros da consulta
limitinteiroOpcional

1–200. Predefinição para 50.

Exemplo: 50

Pedido de exemplo

curl -X GET "https://api.cronlume.com/v1/crons/a870d9ac-3a0f-49bb-b8e2-5f392fffc821/failure-actions?limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": [
        {
            "id": 218,
            "job_id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
            "trigger_failure_count": 3,
            "url": "https://backup.example.com/recover/invoices",
            "duration_ms": 842,
            "status": "succeeded",
            "http_status": 204,
            "worker_id": "scheduler-eu-01"
        }
    ]
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
DOMAIN API

Importar

Estrutura frotas por projeto, site, serviço, cliente e categoria operacional.

GET/groups

Listar grupos

Devolver todos os projetos, sites, serviços ou outros configurados no espaço de trabalho autenticado.

PermissãoQualquer chave de API

Pedido de exemplo

curl -X GET "https://api.cronlume.com/v1/groups" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": [
        {
            "id": "6ef63789-baf1-44fc-99bb-0c5ce2d37a8b",
            "group_type": "service",
            "name": "Billing platform",
            "client_reference": "CLIENT-ACME-0042",
            "description": "Customer billing automation",
            "color": "#147d64"
        }
    ]
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
POSTO/groups

Criar grupo

Crie um projeto, site, serviço ou outro reutilizável para organizar a frota de cron.

PermissãoChave API habilitada para gravação

Campos de solicitação

Corpo JSON
namestringRequerido

Nome de grupo único dentro da área de trabalho.

Exemplo: Billing platform
group_typeenumOpcional

projeto, site, serviço ou outro.

Exemplo: service
client_referencestring onullOpcional

Cliente, contrato ou referência interna. Máximo 160 caracteres.

Exemplo: CLIENT-ACME-0042
descriptionstring onullOpcional

Objetivo e contexto de propriedade.

Exemplo: Customer billing automation
colorcor hexOpcional

Cor do ecrã.

Exemplo: #147d64

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/groups" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "group_type": "service",
    "name": "Billing platform",
    "client_reference": "CLIENT-ACME-0042",
    "description": "Customer billing automation",
    "color": "#147d64"
}'

Resposta do exemplo

201
{
    "data": {
        "id": "6ef63789-baf1-44fc-99bb-0c5ce2d37a8b",
        "group_type": "service",
        "name": "Billing platform",
        "client_reference": "CLIENT-ACME-0042",
        "description": "Customer billing automation",
        "color": "#147d64"
    }
}

Respostas possíveis

201Grupos criados
401Chave API inválida
422Valores inválidos ou duplicados
Preparando o formulário de teste interativo...
PATCH/groups/{group_id}

Atualizar grupo

Mude um ou mais campos. Campos não autorizados permanecem inalterados.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
group_idLocalização do UUIDRequerido

Identificador de grupos.

Exemplo: 6ef63789-baf1-44fc-99bb-0c5ce2d37a8b
Corpo JSON
namestringOpcional

Nome de grupo único dentro da área de trabalho.

Exemplo: Billing platform
group_typeenumOpcional

projeto, site, serviço ou outro.

Exemplo: service
client_referencestring onullOpcional

Cliente, contrato ou referência interna. Máximo 160 caracteres.

Exemplo: CLIENT-ACME-0042
descriptionstring onullOpcional

Objetivo e contexto de propriedade.

Exemplo: Customer billing automation
colorcor hexOpcional

Cor do ecrã.

Exemplo: #147d64

Pedido de exemplo

curl -X PATCH "https://api.cronlume.com/v1/groups/6ef63789-baf1-44fc-99bb-0c5ce2d37a8b" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Billing platform Production"
}'

Resposta do exemplo

200
{
    "updated": true
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
DELETE/groups/{group_id}

Excluir grupo

Suprimir o elemento organizacional. As tarefas permanecem disponíveis; as relações de grupo apagadas ficam vazias.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
group_idLocalização do UUIDRequerido

Identificador de grupos.

Exemplo: 6ef63789-baf1-44fc-99bb-0c5ce2d37a8b

Pedido de exemplo

curl -X DELETE "https://api.cronlume.com/v1/groups/6ef63789-baf1-44fc-99bb-0c5ce2d37a8b" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

204
No response body

Respostas possíveis

204Grupos itens excluídos
401Chave API inválida
404Item não encontrado
Preparando o formulário de teste interativo...
GET/categories

Listar as Categorias

Devolve todas as categorias operacionais configuradas no espaço de trabalho autenticado.

PermissãoQualquer chave de API

Pedido de exemplo

curl -X GET "https://api.cronlume.com/v1/categories" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": [
        {
            "id": "125976d5-c276-481c-984c-a9b4b70e477e",
            "name": "Billing",
            "description": "Invoice and payment workflows",
            "color": "#46769b"
        }
    ]
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
POSTO/categories

Criar categoria

Criar uma categoria operacional reutilizável para organizar a frota de cron.

PermissãoChave API habilitada para gravação

Campos de solicitação

Corpo JSON
namestringRequerido

Nome de categoria único dentro da área de trabalho.

Exemplo: Billing
descriptionstring onullOpcional

Descrição da categoria operacional.

Exemplo: Invoice and payment workflows
colorcor hexOpcional

Cor do ecrã.

Exemplo: #46769b

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/categories" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Billing",
    "description": "Invoice and payment workflows",
    "color": "#46769b"
}'

Resposta do exemplo

201
{
    "data": {
        "id": "125976d5-c276-481c-984c-a9b4b70e477e",
        "name": "Billing",
        "description": "Invoice and payment workflows",
        "color": "#46769b"
    }
}

Respostas possíveis

201Categorias criadas
401Chave API inválida
422Valores inválidos ou duplicados
Preparando o formulário de teste interativo...
PATCH/categories/{category_id}

Actualizar a categoria

Mude um ou mais campos. Campos não autorizados permanecem inalterados.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
category_idLocalização do UUIDRequerido

Identificador das categorias.

Exemplo: 125976d5-c276-481c-984c-a9b4b70e477e
Corpo JSON
namestringOpcional

Nome de categoria único dentro da área de trabalho.

Exemplo: Billing
descriptionstring onullOpcional

Descrição da categoria operacional.

Exemplo: Invoice and payment workflows
colorcor hexOpcional

Cor do ecrã.

Exemplo: #46769b

Pedido de exemplo

curl -X PATCH "https://api.cronlume.com/v1/categories/125976d5-c276-481c-984c-a9b4b70e477e" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Billing Production"
}'

Resposta do exemplo

200
{
    "updated": true
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
DELETE/categories/{category_id}

Apagar a categoria

Suprimir o elemento organizacional. As tarefas permanecem disponíveis; as relações de grupo apagadas ficam vazias.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
category_idLocalização do UUIDRequerido

Identificador das categorias.

Exemplo: 125976d5-c276-481c-984c-a9b4b70e477e

Pedido de exemplo

curl -X DELETE "https://api.cronlume.com/v1/categories/125976d5-c276-481c-984c-a9b4b70e477e" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

204
No response body

Respostas possíveis

204Categorias item excluído
401Chave API inválida
404Item não encontrado
Preparando o formulário de teste interativo...
DOMAIN API

Incidentes

Leia e reconheça falhas que requerem atenção profissional.

GET/incidents

Listar incidentes

Retorne até 500 incidentes ordenados pelo horário de abertura. As respostas contêm histórico operacional aberto, reconhecido e resolvido.

PermissãoQualquer chave de API

Pedido de exemplo

curl -X GET "https://api.cronlume.com/v1/incidents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "data": [
        {
            "id": 731,
            "job_id": "a870d9ac-3a0f-49bb-b8e2-5f392fffc821",
            "cron_name": "Generate customer invoices",
            "status": "open",
            "severity": "critical",
            "summary": "Generate customer invoices failed 3 times",
            "details": "Remote endpoint returned HTTP 503.",
            "failure_count": 3,
            "opened_at": "2026-08-28 20:00:02.000000",
            "acknowledged_at": null,
            "resolved_at": null
        }
    ]
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...
POSTO/incidents/{incident_id}/acknowledge

Reconheça um incidente

Marque um incidente aberto como reconhecido e registre o tempo exato de reconhecimento UTC.

PermissãoChave API habilitada para gravação

Campos de solicitação

Parâmetros do caminho
incident_idcaminho inteiroRequerido

Identificador do incidente.

Exemplo: 731

Pedido de exemplo

curl -X POST "https://api.cronlume.com/v1/incidents/731/acknowledge" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Resposta do exemplo

200
{
    "acknowledged": true
}

Respostas possíveis

200Pedido concluído com sucesso
401Chave de API em falta, inválida ou expirada
403Autorização insuficiente
422A validação da solicitação falhou
Preparando o formulário de teste interativo...