> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/switch-infrastructure/config-manager/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/switch-infrastructure/config-manager/_mcp/server. # Create or update a config file POST /v1/config/{device_uuid}/{filename} Content-Type: application/json Create or update a configuration file. If the content has not changed, the existing version is returned without creating a new one. Reference: https://docs.nvidia.com/switch-infrastructure/config-manager/switch-infrastructure/config-manager/services/config-store/config-store-api/config/create-config-v-1-config-device-uuid-filename-post ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: config-store-api version: 1.0.0 paths: /v1/config/{device_uuid}/{filename}: post: operationId: create_config_v1_config__device_uuid___filename__post summary: Create or update a config file description: >- Create or update a configuration file. If the content has not changed, the existing version is returned without creating a new one. tags: - config parameters: - name: device_uuid in: path required: true schema: type: string format: uuid - name: filename in: path required: true schema: type: string - name: Authorization in: header description: >- 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. required: true schema: type: string responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConfigResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigCreateRequest' components: schemas: FileType: type: string enum: - intended - backup description: Enum for config file types. title: FileType ConfigCreateRequest: type: object properties: author: type: string description: Author email commit_message: type: string description: Commit message describing the change content: type: string description: Configuration file content created_at: type: - string - 'null' format: date-time description: Optional timestamp for the version (defaults to current time) file_type: $ref: '#/components/schemas/FileType' description: Config file type (intended or backup) required: - author - commit_message - content description: Request to create/update a config file. title: ConfigCreateRequest DeviceMetadata: type: object properties: last_updated: type: - string - 'null' format: date-time description: When metadata was last refreshed name: type: string description: Device name nautobot_url: type: - string - 'null' description: Link to device in Nautobot platform: type: - string - 'null' description: Platform/OS name primary_ip4: type: - string - 'null' description: Primary IPv4 address rack: type: - string - 'null' description: Rack name role: type: - string - 'null' description: Device role site: type: string description: Site name required: - name - site description: Device metadata from Nautobot. title: DeviceMetadata ConfigResponse: type: object properties: author: type: string description: Author email commit_message: type: string description: Commit message content: type: string description: Configuration file content content_hash: type: string description: SHA256 hash of content created_at: type: string format: date-time description: Timestamp when version was created device: oneOf: - $ref: '#/components/schemas/DeviceMetadata' - type: 'null' description: Device metadata from Nautobot device_uuid: type: string format: uuid description: Device UUID file_type: $ref: '#/components/schemas/FileType' description: Config file type (intended or backup) filename: type: string description: File name id: type: string format: uuid description: Config file ID version: type: integer description: Version number required: - author - commit_message - content - content_hash - created_at - device_uuid - file_type - filename - id - version description: Response with full config data. title: ConfigResponse ValidationErrorCtx: type: object properties: {} title: ValidationErrorCtx ValidationErrorLocItems: oneOf: - type: string - type: integer title: ValidationErrorLocItems ValidationError: type: object properties: ctx: $ref: '#/components/schemas/ValidationErrorCtx' input: description: Any type loc: type: array items: $ref: '#/components/schemas/ValidationErrorLocItems' msg: type: string type: type: string required: - loc - msg - type title: ValidationError HTTPValidationError: type: object properties: detail: type: array items: $ref: '#/components/schemas/ValidationError' title: HTTPValidationError securitySchemes: BearerAuth: type: http scheme: bearer description: >- 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. ``` ## Examples **Request** ```json { "author": "admin@example.com", "commit_message": "Update interface configuration to enable OSPF", "content": "interface GigabitEthernet0/1\n ip address 192.168.1.1 255.255.255.0\n ip ospf 1 area 0\n!" } ``` **Response** ```json { "author": "admin@example.com", "commit_message": "Update interface configuration to enable OSPF", "content": "interface GigabitEthernet0/1\n ip address 192.168.1.1 255.255.255.0\n ip ospf 1 area 0\n!", "content_hash": "3a7bd3e2360a3d5f8b9e2c4d5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a", "created_at": "2024-01-15T09:30:00Z", "device_uuid": "123e4567-e89b-12d3-a456-426614174000", "file_type": "intended", "filename": "GigabitEthernet0-1.cfg", "id": "9f8c7d6e-5b4a-3c2d-1e0f-123456789abc", "version": 3, "device": { "name": "CoreRouter01", "site": "DataCenter-East", "last_updated": "2024-01-15T09:30:00Z", "nautobot_url": "https://nautobot.example.com/dcim/devices/123e4567-e89b-12d3-a456-426614174000", "platform": "Cisco IOS XE", "primary_ip4": "10.0.0.1", "rack": "Rack-22B", "role": "Core Router" } } ``` **SDK Code** ```python import requests url = "https://api.example.com/v1/config/device_uuid/filename" payload = { "author": "admin@example.com", "commit_message": "Update interface configuration to enable OSPF", "content": "interface GigabitEthernet0/1 ip address 192.168.1.1 255.255.255.0 ip ospf 1 area 0 !" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.example.com/v1/config/device_uuid/filename'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"author":"admin@example.com","commit_message":"Update interface configuration to enable OSPF","content":"interface GigabitEthernet0/1\n ip address 192.168.1.1 255.255.255.0\n ip ospf 1 area 0\n!"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.example.com/v1/config/device_uuid/filename" payload := strings.NewReader("{\n \"author\": \"admin@example.com\",\n \"commit_message\": \"Update interface configuration to enable OSPF\",\n \"content\": \"interface GigabitEthernet0/1\\n ip address 192.168.1.1 255.255.255.0\\n ip ospf 1 area 0\\n!\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.example.com/v1/config/device_uuid/filename") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"author\": \"admin@example.com\",\n \"commit_message\": \"Update interface configuration to enable OSPF\",\n \"content\": \"interface GigabitEthernet0/1\\n ip address 192.168.1.1 255.255.255.0\\n ip ospf 1 area 0\\n!\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.example.com/v1/config/device_uuid/filename") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"author\": \"admin@example.com\",\n \"commit_message\": \"Update interface configuration to enable OSPF\",\n \"content\": \"interface GigabitEthernet0/1\\n ip address 192.168.1.1 255.255.255.0\\n ip ospf 1 area 0\\n!\"\n}") .asString(); ``` ```php request('POST', 'https://api.example.com/v1/config/device_uuid/filename', [ 'body' => '{ "author": "admin@example.com", "commit_message": "Update interface configuration to enable OSPF", "content": "interface GigabitEthernet0/1\\n ip address 192.168.1.1 255.255.255.0\\n ip ospf 1 area 0\\n!" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.example.com/v1/config/device_uuid/filename"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"author\": \"admin@example.com\",\n \"commit_message\": \"Update interface configuration to enable OSPF\",\n \"content\": \"interface GigabitEthernet0/1\\n ip address 192.168.1.1 255.255.255.0\\n ip ospf 1 area 0\\n!\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "author": "admin@example.com", "commit_message": "Update interface configuration to enable OSPF", "content": "interface GigabitEthernet0/1 ip address 192.168.1.1 255.255.255.0 ip ospf 1 area 0 !" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/v1/config/device_uuid/filename")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```