Create or update a config file

POST

https://host.com/v1/config/:device_uuid/:filename

POST

/v1/config/:device_uuid/:filename

$ curl -X POST https://host.com/v1/config/device_uuid/filename \
>      -H "Content-Type: application/json" \
>      -d '{
>   "author": "admin@example.com",
>   "commit_message": "Update interface configuration for VLAN changes",
>   "content": "interface GigabitEthernet0/1\n description Uplink to Core Switch\n switchport mode trunk\n switchport trunk allowed vlan 10,20,30\n no shutdown"
> }'

1 {
2   "author": "admin@example.com",
3   "commit_message": "Update interface configuration for VLAN changes",
4   "content": "interface GigabitEthernet0/1\n description Uplink to Core Switch\n switchport mode trunk\n switchport trunk allowed vlan 10,20,30\n no shutdown",
5   "content_hash": "3a7bd3e2360a3d5f8e2b9c4f1a2d5e6f7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e",
6   "created_at": "2024-01-15T09:30:00Z",
7   "device_uuid": "123e4567-e89b-12d3-a456-426614174000",
8   "file_type": "intended",
9   "filename": "GigabitEthernet0_1.cfg",
10   "id": "9f8c7d6e-5b4a-3c2d-1e0f-123456789abc",
11   "version": 3,
12   "device": {
13     "name": "CoreSwitch01",
14     "site": "Data Center 1",
15     "last_updated": "2024-01-15T09:30:00Z",
16     "nautobot_url": "https://nautobot.example.com/dcim/devices/123e4567-e89b-12d3-a456-426614174000",
17     "platform": "Cisco IOS XE",
18     "primary_ip4": "192.168.1.10",
19     "rack": "Rack42",
20     "role": "Core Switch"
21   }
22 }

Create or update a configuration file. If the content has not changed, the existing version is returned without creating a new one.

Path parameters

device_uuidstringRequiredformat: "uuid"

filenamestringRequired

Request

This endpoint expects an object.

authorstringRequired

Author email

commit_messagestringRequired

Commit message describing the change

contentstringRequired

Configuration file content

created_atdatetime or nullOptional

Optional timestamp for the version (defaults to current time)

file_typeenumOptional

Config file type (intended or backup)

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