> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myrmex.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# NetBox

> Conecte o NetBox ao Myrmex com um token da API REST — crie o token e adicione a integração.

import { Note, Steps, Step, CardGroup, Card, Tip } from '@mintlify/components';

Conecte seu **NetBox** IPAM/DCIM para que o Myrmex possa ler seu inventário de fonte da verdade em tempo real — sites, racks, dispositivos, endereços IP, prefixos e VLANs. O Myrmex conecta-se pela **API REST do NetBox** usando um token de API.

## O Que o Myrmex Pode Fazer

<CardGroup cols={2}>
  <Card title="Ler o inventário" icon="boxes-stacked">
    Traga sites, racks, dispositivos, endereços IP, prefixos e VLANs da sua fonte da verdade, sob demanda.
  </Card>

  <Card title="Saúde e métricas" icon="chart-line">
    Verifique a saúde e as métricas do NetBox IPAM/DCIM pela API.
  </Card>

  <Card title="Referência cruzada" icon="diagram-project">
    Correlacione registros do NetBox com dados das suas outras integrações durante investigações.
  </Card>

  <Card title="Perguntar no Workspace" icon="magnifying-glass">
    Consulte seu inventário em linguagem natural.
  </Card>
</CardGroup>

## Antes de Começar

* Uma instância do **NetBox** acessível (o Myrmex conecta-se via HTTPS; opcionalmente através de um [Collector](/pt/documentation/agent-endpoint-security/collector-mode) se o NetBox estiver em uma rede privada).
* Uma **conta de usuário** do NetBox cujas permissões cubram os objetos que você quer que o Myrmex leia (somente leitura é suficiente para análise).
* Permissão para criar um **token de API** para esse usuário.

## Passo 1 — Crie o Token de API no NetBox

<Steps>
  <Step title="Abra seus tokens de API">
    No NetBox, abra o menu do seu usuário e vá em **API Tokens** (ou **Admin → API Tokens**).
  </Step>

  <Step title="Adicione um token">
    Clique em **Add a token** e atribua-o à conta somente leitura. Desmarque **Write enabled** para manter o token como somente leitura.
  </Step>

  <Step title="Copie o token completo">
    Copie a string completa do token, incluindo o prefixo, o nome e o separador de ponto — o formato é `nbt_{name}.{token}`. Armazene-o com segurança; você o colará no Myrmex.
  </Step>
</Steps>

<Tip>
  Restrinja o token a uma conta somente leitura e, se houver suporte, limite-o por IP de origem para que só possa ser usado a partir do seu Collector ou do Myrmex.
</Tip>

## Passo 2 — Adicione a Integração no Myrmex

No **Directory**, escolha **Add Integration → NetBox** e preencha:

| Field           | Descrição                                                                                                       |
| --------------- | --------------------------------------------------------------------------------------------------------------- |
| **Name**        | Um nome único para esta instância do NetBox.                                                                    |
| **Description** | Nota opcional para identificá-la.                                                                               |
| **API Token**   | A string completa do token no formato `nbt_{name}.{token}` — inclua o prefixo, o nome e o separador de ponto.   |
| **URL**         | O host ou URL base do NetBox que o Myrmex deve chamar.                                                          |
| **Protocol**    | `https` ou `http` (HTTPS recomendado).                                                                          |
| **Port**        | A porta da API (`443` ou `80`).                                                                                 |
| **Collector**   | [Collector](/pt/documentation/agent-endpoint-security/collector-mode) opcional para alcançar um NetBox privado. |

## Conectar

Clique em **Connect** para validar o token e concluir. O NetBox então aparece em **Environment → Integrations**, pronto para ser consultado no Workspace.

<Note>
  O Myrmex lê do NetBox em tempo real pela API cada vez que você pergunta — nada da sua instância do NetBox é armazenado no lado do Myrmex.
</Note>
