BackReady / Visão geral
Não testado

BACKREADY API · V1

Console de integração

Configure, teste e explore todos os recursos disponíveis na API em um só lugar.

BASE CONFIGURADA/BackReady/api/v1
○ Token não informado
↗
ENDPOINTS3

1 público · 2 protegidos

⌁
AUTENTICAÇÃOBearer

Token opaco do projeto

◷
RATE LIMIT30/min

Por agente no heartbeat

OPERAÇÕES DISPONÍVEIS

Endpoints da API

CONEXÃO

Configuração da API

Defina o servidor e a credencial usada nos testes desta sessão.

Dados da conexão

GET

/health

Confirma que a aplicação HTTP está disponível. Este endpoint não exige autenticação.

Requisição

GET/BackReady/api/v1/health

Não possui parâmetros, query string ou corpo.

Resposta

Aguardando execução
A resposta aparecerá aqui.
POST

/agent/heartbeat

Registra o contato do agente e atualiza o projeto associado à credencial.

Requisição protegida

POST/BackReady/api/v1/agent/heartbeat
🔒 Exige Bearer token configurado

Não envie corpo. Em sucesso, retorna status, project_id e horário UTC.

Resposta

Aguardando execução
A resposta aparecerá aqui.
POST

/agent/inventory

Envia a descoberta do ambiente para revisão humana. Sucesso não habilita capturas.

Corpo JSON

POST/BackReady/api/v1/agent/inventory

Resposta

Aguardando execução
A resposta aparecerá aqui.

OPENAPI 3.1

Documentação interativa

Consulte schemas, parâmetros, exemplos e respostas. O botão Authorize usa o token configurado nesta sessão.

↓ Baixar contrato YAML

INTEGRAÇÃO

Exemplos de código

Copie os exemplos e forneça URL e token pelo ambiente privado da aplicação.

Evite modo verbose: ferramentas em modo de depuração podem registrar o cabeçalho Authorization e expor a credencial.


            
DIAGNÓSTICO
Respostas HTTP
Use o status HTTP antes de interpretar o corpo. Erros de rota ou tamanho podem retornar texto.
200
Sucesso
Operação concluída. Heartbeat aceito ou Health disponível.
202
Registrado
Inventário recebido e aguardando revisão humana.
401
Não autorizado
Token ausente, inválido ou revogado.
413
Muito grande
Corpo acima do limite global de 65.536 bytes.
422
Inválido
Inventário fora do schema ou com campos não permitidos.
426
HTTPS obrigatório
A conexão precisa usar TLS.
429
Limite atingido
Aguarde antes de tentar novamente.
500
Erro interno
Anote X-Request-Id, horário UTC, método e caminho.