Get diff between two versions

GET

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

GET

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

$ curl -G /v1/config/device_uuid/filename/diff \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d from_version=1 \
>      -d to_version=1

1 {
2   "device_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "diff": "--- config_v1.txt\t2024-04-01 10:00:00\n+++ config_v2.txt\t2024-04-02 10:00:00\n@@ -1,5 +1,6 @@\n interface GigabitEthernet0/1\n- description Uplink to ISP\n+ description Uplink to ISP - updated\n ip address 10.0.0.1 255.255.255.0\n+ no shutdown\n router ospf 1\n- network 10.0.0.0 0.0.0.255 area 0\n+ network 10.0.0.0 0.0.0.255 area 0\n",
4   "diff_stats": {
5     "files_changed": 1,
6     "lines_added": 2,
7     "lines_removed": 1
8   },
9   "filename": "config_v1.txt",
10   "from_version": 1,
11   "new_content": "interface GigabitEthernet0/1\ndescription Uplink to ISP - updated\nip address 10.0.0.1 255.255.255.0\nno shutdown\nrouter ospf 1\nnetwork 10.0.0.0 0.0.0.255 area 0\n",
12   "old_content": "interface GigabitEthernet0/1\ndescription Uplink to ISP\nip address 10.0.0.1 255.255.255.0\nrouter ospf 1\nnetwork 10.0.0.0 0.0.0.255 area 0\n",
13   "to_version": 2,
14   "device": {
15     "name": "CoreRouter01",
16     "site": "DataCenter-East",
17     "last_updated": "2024-01-15T09:30:00Z",
18     "nautobot_url": "https://nautobot.example.com/dcim/devices/1234",
19     "platform": "Cisco IOS-XE",
20     "primary_ip4": "192.168.1.1",
21     "rack": "Rack-22B",
22     "role": "Core Router"
23   }
24 }

Generate a diff between two 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

from_versionintegerRequired

to_versionintegerRequired

file_typeenumOptional

Enum for config file types.

Allowed values:

Response

Successful Response

device_uuidstringformat: "uuid"

Device UUID

diffstring

Unified diff output

diff_statsmap from strings to integers

Statistics about the diff

filenamestring

File name

from_versioninteger

Source version

new_contentstring

Content of target version

old_contentstring

Content of source version

to_versioninteger

Target version

deviceobject or null

Device metadata from Nautobot

Errors

422

Unprocessable Entity Error