{"library":"pynautobot","title":"Nautobot API Client Library","description":"pynautobot is the official API client library for Nautobot, a Network Source of Truth and Automation Platform. It provides a Pythonic interface to interact with the Nautobot REST API. The current version is 3.1.0, and new major versions are released to align with Nautobot core major releases, with frequent minor and patch updates in between.","language":"python","status":"active","last_verified":"Mon May 18","install":{"commands":["pip install pynautobot"],"cli":null},"imports":["from pynautobot import api"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import os\nfrom pynautobot import api\n\nNAUTOBOT_URL = os.environ.get(\"NAUTOBOT_URL\", \"https://nautobot.example.com\")\nNAUTOBOT_TOKEN = os.environ.get(\"NAUTOBOT_TOKEN\", \"YOUR_NAUTOBOT_TOKEN_HERE\")\n\nif not NAUTOBOT_URL or not NAUTOBOT_TOKEN:\n    print(\"Please set NAUTOBOT_URL and NAUTOBOT_TOKEN environment variables.\")\n    exit(1)\n\ntry:\n    # Initialize the pynautobot API client\n    nautobot = api(url=NAUTOBOT_URL, token=NAUTOBOT_TOKEN)\n\n    # Fetch all devices\n    print(f\"Connecting to Nautobot at {NAUTOBOT_URL}...\")\n    devices = nautobot.dcim.devices.all()\n\n    if devices:\n        print(f\"Found {len(devices)} devices:\")\n        for device in devices[:5]: # Print first 5 devices\n            print(f\"- {device.name} ({device.device_type.model}) in {device.site.name}\")\n    else:\n        print(\"No devices found.\")\n\n    # Example: Create a new tag\n    # new_tag = nautobot.extras.tags.create(name=\"my-new-tag\", slug=\"my-new-tag\", description=\"A tag created by pynautobot\")\n    # print(f\"Created tag: {new_tag.name}\")\n\nexcept Exception as e:\n    print(f\"An error occurred: {e}\")","lang":"python","description":"This quickstart initializes the pynautobot API client using environment variables for the Nautobot URL and API token. It then fetches and prints the names of the first five devices found in your Nautobot instance. Ensure `NAUTOBOT_URL` and `NAUTOBOT_TOKEN` are set in your environment.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-18","installed_version":"2.7.2","pypi_latest":"3.1.0","is_stale":true,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":2.2,"avg_import_s":0.62,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.61,"mem_mb":10.5,"disk_size":"22.2M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.2,"import_time_s":0.38,"mem_mb":10.5,"disk_size":"23M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.74,"mem_mb":11.5,"disk_size":"24.5M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.2,"import_time_s":0.64,"mem_mb":11.5,"disk_size":"25M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.76,"mem_mb":12.6,"disk_size":"16.2M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.1,"import_time_s":0.67,"mem_mb":12.6,"disk_size":"17M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.71,"mem_mb":12.9,"disk_size":"16.0M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.1,"import_time_s":0.64,"mem_mb":12.9,"disk_size":"16M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.57,"mem_mb":10.3,"disk_size":"21.5M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"pynautobot","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.6,"import_time_s":0.5,"mem_mb":10.3,"disk_size":"22M"}]}}