Get a config file

GET

///v1/config/:device_uuid/:filename

GET

/v1/config/:device_uuid/:filename

$ curl /v1/config/device_uuid/filename \
>      -H "Authorization: Bearer <token>" \
>      -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": "3a7bd3e2360a3d5f8b9c1e4f2a7d9c8e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c",
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.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

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)

filenamestring

File name

idstringformat: "uuid"

Config file ID

versioninteger

Version number

deviceobject or null

Device metadata from Nautobot

Errors

422

Unprocessable Entity Error