Labyrix
    Documentação

    Comece em minutos

    Instale a CLI, autentique com sua API key e rode seu primeiro recon — depois automatize tudo pela REST API da Labyrix.

    Visão geral

    A Labyrix é composta por três interfaces: o portal web para visualizar e gerenciar ativos, a CLI em Go que executa o pipeline de recon, e a REST API para ingestão e automação. Todos operam sobre o mesmo modelo de dados, organizados por workspace.

    1. Instalar a CLI

    A CLI (ariadne) roda em Linux, macOS e Windows. Instale via script ou com Go:

    instalação
    # via script
    $ curl -fsSL https://get.labyrix.com | sh
    # ou via Go
    $ go install github.com/labyrix/ariadne-cli/cmd/ariadne@latest
    $ ariadne --version

    2. Autenticar

    Gere uma API key no portal em Settings → API Keys (as chaves começam com labyrix_sk_). Configure a CLI de forma interativa:

    autenticação
    $ ariadne configure
    API key: labyrix_sk_••••••••
    Workspace ID: b1a2c3d4-…
    ✓ credenciais validadas e salvas

    Em ambientes não interativos (CI), use variáveis de ambiente:

    variáveis de ambiente
    $ export LABYRIX_API_KEY=labyrix_sk_…
    $ export LABYRIX_WORKSPACE_ID=<uuid>

    3. Rodar o primeiro recon

    Aponte a CLI para um domínio que você tem autorização para testar. O pipeline descobre subdomínios, resolve DNS, escaneia portas, faz probing web e envia tudo para o seu workspace:

    primeiro recon
    $ ariadne recon run --domain example.com
    [+] subfinder 256 subdomínios
    [+] dnsx 198 resolvidos
    [+] naabu 1.000 portas · 42 serviços
    [+] httpx 134 URLs web
    [+] nuclei 7 findings (2 high)
    ↑ upload → workspace sincronizado

    Os resultados aparecem imediatamente no portal, em Scope.

    4. Quickstart da API REST

    A API vive em https://api.labyrix.com. Autentique com os headers x-api-key e x-workspace-id.

    listar subdomínios
    $ curl https://api.labyrix.com/v1/subdomains?page=1&pageSize=50 \
    -H "x-api-key: labyrix_sk_…" \
    -H "x-workspace-id: <uuid>"
    # 200 OK
    { "data": [ { "hostname": "api.example.com",
    "status": "live", "ports": [443],
    "cloud_provider": "cloudflare" } ],
    "total": 8934, "page": 1 }

    Ingerir dados é igualmente simples — envie um batch (até 5000 itens):

    ingerir subdomínios
    $ curl -X POST https://api.labyrix.com/v1/subdomains \
    -H "x-api-key: labyrix_sk_…" \
    -H "x-workspace-id: <uuid>" \
    -d '[{"hostname":"new.example.com","source":"api"}]'

    Principais endpoints

    MétodoPath
    POST/v1/domains
    POST/v1/subdomains
    POST/v1/urls
    POST/v1/infra
    POST/v1/emails
    POST/v1/runs
    POST/v1/scans
    GET/v1/subdomains

    Escopos de API key: assets:read, assets:write, findings:*, scans:*, logs:write.

    Pronto para o primeiro scan?

    Crie sua conta e gere uma API key em minutos.

    Começar grátis