{"type":"api","title":"Get all configuration files","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/dde5e726-00af-392c-8b10-177b4e676897","info":{"title":"Crosswork ZTP Configuration Service API","version":"7.1.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"description":"This document explains the Crosswork REST APIs that you can use to manage configuration files for Zero Touch Provisioning (ZTP) devices."},"security":[{"bearerAuth":[]}],"tags":[{"name":"Device Platform APIs","description":"List of Device Platform APIs."},{"name":"Config APIs","description":"List of Config APIs."}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/ztp-config-service-deprecated-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"/crosswork/configsvc/v1"}],"securitySchemes":{"bearerAuth":{"description":"Security definitions details.","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"tags":["Config APIs"],"summary":"Get all configuration files","description":"This API gets details of all configuration files.","operationId":"getAllConfigFilesUsingGET","deprecated":true,"parameters":[{"description":"Crosswork host IP","in":"header","name":"X-Real-IP","required":false,"schema":{"type":"string"}},{"description":"Offset","in":"query","name":"PageNum","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Limit","in":"query","name":"PageSize","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Sort by column.","in":"query","name":"SortBy","required":false,"schema":{"type":"string"}},{"description":"Sort by decending order.","in":"query","name":"Descending","required":false,"schema":{"type":"boolean"}},{"description":"Name of the configuration.","in":"query","name":"confname","required":false,"schema":{"type":"string"}},{"description":"ID of the configuration.","in":"query","name":"confId","required":false,"schema":{"type":"string"}},{"description":"Config type","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"OS platform","in":"query","name":"osname","required":false,"schema":{"type":"string"}},{"description":"OS version","in":"query","name":"version","required":false,"schema":{"type":"string"}},{"description":"Device family","in":"query","name":"devicefamily","required":false,"schema":{"type":"string"}},{"description":"Vendor","in":"query","name":"vendor","required":false,"schema":{"type":"string"}},{"description":"Matching pattern","in":"query","name":"searchType","required":false,"schema":{"type":"string"}},{"description":"File name","in":"query","name":"fileName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"properties":{"content":{"description":"Data for a single config.","items":{"type":"object"},"type":"array"},"pageNumber":{"format":"int32","type":"integer","description":"Indicates the page number in the list of records, paginated by \"pageSize\"."},"pageSize":{"format":"int32","type":"integer","description":"Number of records to be returned in a single response."}},"description":"Config response object.","type":"object","$$ref":"#/components/schemas/ConfigResponseDto"},"example":{"Success Response":{"value":{"content":[{"childIds":"","confId":"b4d4504c-2a0f-4b68-84a3-a0273eabcf03","confName":"cfg2","createdBy":"admin","createdTime":"1686906062163","deviceFamily":"CISCO NCS540","downloadurl":"http://\u003cCW_HOST_IP\u003e:30604/crosswork/configsvc/v1/configs/device/files/b4d4504c-2a0f-4b68-84a3-a0273eabcf03","extraPlaceHolders":"hname","fileName":"ncs5k_day0_w_variables.txt","modifiedBy":"admin","modifiedTime":"1686906062163","osName":"IOS XR","size":106,"type":"Day0-config","vendor":"CISCO","version":"7.0.2"}],"pageNumber":1,"pageSize":1}}}}}},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"404":{"description":"Not Found. The client made a request for a resource that does not exist."}},"__originalOperationId":"getAllConfigFilesUsingGET","security":[{"bearerAuth":[]}],"method":"get","path":"/configs"}}