Skip to content
TrustedSkillsbeta
Back to all skills

Netbox Integration Best Practices

Checked
netboxlabs·vlatest·backend·Apache-2.0

Helps with integration, best practices as part of agent workflows workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add netboxlabs/netbox-best-practices --skill netbox-integration-best-practices -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

netboxlabs

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned netboxlabs/netbox-best-practices at 64153ee9e5.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
64153ee9e5
Manifest
skills/netbox-integration-best-practices/SKILL.md
Scanned
45 files, 8,193 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill provides guidance and best practices for integrating with NetBox using its REST and GraphQL APIs. It helps engineers, developers, and teams build robust integrations and automations by outlining recommended patterns and addressing common pitfalls. The skill focuses on API integration specifically; it does not cover plugin development or NetBox administration tasks.

When to use it

  • When building new NetBox API integrations.
  • During reviews of existing integration code.
  • When troubleshooting performance issues related to NetBox API interactions.
  • For planning the architecture of automations that interact with NetBox.
  • When writing scripts that need to communicate with NetBox.

Key capabilities

  • Provides best practice guidance for NetBox REST API integrations, including pagination, update methods (PATCH vs PUT), and filtering techniques.
  • Offers recommendations for using the NetBox GraphQL API (version 2.9+).
  • Details authentication requirements, emphasizing the use of v2 tokens (NetBox 4.5+) and migration away from deprecated v1 tokens (before NetBox 4.7).
  • Categorizes best practices by priority level (Critical, High, Medium, Low) to guide implementation efforts.

Example prompts

  • "What's the recommended way to authenticate with the NetBox API?"
  • "How should I handle pagination when retrieving data from a NetBox REST endpoint?"
  • "Best practices for updating a single field in NetBox using the API."

Tips & gotchas

  • NetBox Version: This skill is primarily targeted towards NetBox versions 4.4 and higher, with optimal support for version 4.5 or later to leverage v2 token features.
  • GraphQL Requirement: GraphQL functionality requires NetBox version 2.9+.
  • Performance Considerations: Be mindful of performance implications when using the ?q= search filter in REST APIs; prioritize specific filters instead. Excluding config_context can also significantly improve performance.