GraphQL and HTTP¶
nbx graphql --help¶
Usage: nbx graphql [OPTIONS] QUERY
Execute a GraphQL query against the NetBox API, or launch the GraphQL TUI.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * query TEXT GraphQL query string, or 'tui' to launch the GraphQL │
│ TUI │
│ [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --variables -v TEXT GraphQL variables: one JSON object, or repeat for │
│ multiple key=value pairs │
│ --json Output raw JSON │
│ --yaml Output YAML │
│ --theme For `nbx graphql tui`: list available themes or │
│ launch with `--theme <name>`. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 3.968s
nbx call --help¶
Usage: nbx call [OPTIONS] METHOD PATH
Call an arbitrary NetBox API path.
╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ * method TEXT [required] │
│ * path TEXT [required] │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --query -q TEXT Query parameter key=value │
│ --body-json TEXT Inline JSON request body │
│ --body-file TEXT Path to JSON request body file │
│ --json Output raw JSON │
│ --yaml Output YAML │
│ --markdown Output Markdown (mutually exclusive with │
│ --json/--yaml) │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
exit 0 4.014s