List all versions of a config file

GET

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

GET

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

$ curl /v1/config/device_uuid/filename/versions \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "device_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "filename": "running-config.cfg",
4   "versions": [
5     {
6       "author": "admin@example.com",
7       "commit_message": "Initial configuration commit",
8       "content_hash": "a3f5c8d9e7b4f1a2c6d8e9f0b1a2c3d4e5f67890abcdef1234567890abcdef12",
9       "created_at": "2024-01-15T09:30:00Z",
10       "file_type": "intended",
11       "version": 1
12     },
13     {
14       "author": "netops@example.com",
15       "commit_message": "Updated VLAN settings",
16       "content_hash": "b4e6d7f8a9c0b1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f67890abcdef1234567890",
17       "created_at": "2024-02-10T14:45:00Z",
18       "file_type": "intended",
19       "version": 2
20     },
21     {
22       "author": "backup@example.com",
23       "commit_message": "Backup before major upgrade",
24       "content_hash": "c5f7e8d9b0a1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7890abcdef1234567890a",
25       "created_at": "2024-03-05T08:20:00Z",
26       "file_type": "backup",
27       "version": 3
28     }
29   ],
30   "device": {
31     "name": "CoreRouter01",
32     "site": "Data Center East",
33     "last_updated": "2024-01-15T09:30:00Z",
34     "nautobot_url": "https://nautobot.example.com/dcim/devices/1234",
35     "platform": "Cisco IOS-XE",
36     "primary_ip4": "192.168.1.10",
37     "rack": "Rack-22B",
38     "role": "Core Router"
39   }
40 }

List all versions of a configuration file.

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:

limitintegerOptionalDefaults to 100

Response

Successful Response

device_uuidstringformat: "uuid"

Device UUID

filenamestring

File name

versionslist of objects

List of versions

deviceobject or null

Device metadata from Nautobot

Errors

422

Unprocessable Entity Error