vértice
Produto Preços Painel
Fila

Cancelar um job pendente

Cancela um job que ainda está pendente.

API key Escopo write
Exemplo de requisição
curl -X DELETE "https://seu-dominio/instances/:id/queue/:jobId" \
  -H "x-api-key: $VERTICE_API_KEY"
DELETE /instances/{id}/queue/{jobId}
API key
Entenda

Conceituação

Cancela um job que ainda está pendente. Jobs já enviados não são afetados.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Contrato

Atributos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

Path

id string obrigatório

ID da instância.

jobId string obrigatório

ID do job na fila.

Contrato

Resposta

204

A operação responde 204 sem corpo.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401 Credencial ausente, inválida ou sessão expirada.
403 Escopo insuficiente, IP não autorizado ou workspace suspenso.
404 Recurso não encontrado ou pertence a outro workspace.
429 Fila cheia, limite de tentativas ou rate limit.