For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • NVIDIA Switch Infrastructure
    • I want to...
  • Quick Start
    • Start Here
    • Getting Started with Config Manager
    • TUI Wizard Reference
    • Configuration Samples
    • Interfaces
    • Local Development Quick Start
    • First Run Tour
  • Config Manager Overview
    • Config Manager Concepts
    • Getting Started with Nautobot
  • User Guides
    • New Site Bringup
    • Workflow Lifecycle
  • Deployment
    • Hosting Options
    • Network Topology Requirements
    • Firewall Ports
    • Airgapped Deployment
    • Troubleshooting
  • Services
      • Overview
      • Architecture
        • GETCurrent User Info
          • GETGet all configs for a device
          • POSTBatch create/update config files
          • GETGet a config file
          • POSTCreate or update a config file
          • GETGet diff between two versions
          • GETList all versions of a config file
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogo
ServicesConfig Store ServiceConfig Store APIconfig

Get a config file

||View as Markdown|
GET
https://host.com/v1/config/:device_uuid/:filename
GET
/v1/config/:device_uuid/:filename
$curl https://host.com/v1/config/device_uuid/filename \
>     -H "Content-Type: application/json"
1{
2  "author": "admin@example.com",
3  "commit_message": "Updated interface VLAN configuration",
4  "content": "interface GigabitEthernet0/1\n description Uplink to Core Switch\n switchport mode trunk\n switchport trunk allowed vlan 10,20,30\n!",
5  "content_hash": "3a7bd3e2360a3d5f8e2b9a1c4d5f6e7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e",
6  "created_at": "2024-01-15T09:30:00Z",
7  "device_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
8  "file_type": "intended",
9  "filename": "running-config.cfg",
10  "id": "9b2d7f4e-1c3a-4f5b-8d6e-7a9c0b1d2e3f",
11  "version": 3,
12  "device": {
13    "name": "Switch-01",
14    "site": "Data Center 1",
15    "last_updated": "2024-01-15T09:30:00Z",
16    "nautobot_url": "https://nautobot.example.com/dcim/devices/1234",
17    "platform": "Cisco IOS XE",
18    "primary_ip4": "192.168.1.10",
19    "rack": "Rack-22",
20    "role": "Access Switch"
21  }
22}
Get a configuration file. If version is not specified, returns the latest version.
Previous

Batch create/update config files

Next

Create or update a config file

Path parameters

device_uuidstringRequiredformat: "uuid"
filenamestringRequired

Query parameters

file_typeenumOptional
Enum for config file types.
Allowed values:
versioninteger or nullOptional

Response

Successful Response
authorstring
Author email
commit_messagestring
Commit message
contentstring
Configuration file content
content_hashstring
SHA256 hash of content
created_atdatetime
Timestamp when version was created
device_uuidstringformat: "uuid"
Device UUID
file_typeenum

Config file type (intended or backup)

Allowed values:
filenamestring
File name
idstringformat: "uuid"
Config file ID
versioninteger
Version number
deviceobject or null
Device metadata from Nautobot

Errors

422
Unprocessable Entity Error