{"type":"api","title":"Get software image details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getSoftwareImageDetails","tags":["Software Image Management (SWIM)"],"summary":"Get software image details","deprecated":false,"description":"Returns software image list based on a filter criteria. For example: \"filterbyName = cat3k%\"","parameters":[{"name":"imageUuid","description":"imageUuid","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"name","description":"name","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"family","description":"family","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"applicationType","description":"applicationType","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"imageIntegrityStatus","description":"imageIntegrityStatus - FAILURE, UNKNOWN, VERIFIED","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"version","description":"software Image Version","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"imageSeries","description":"image Series","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"imageName","description":"image Name","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"isTaggedGolden","description":"is Tagged Golden","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"isCCORecommended","description":"is recommended from cisco.com","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"isCCOLatest","description":"is latest from cisco.com","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"createdTime","description":"time in milliseconds (epoch format)","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"imageSizeGreaterThan","description":"size in bytes","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"imageSizeLesserThan","description":"size in bytes","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"sortBy","description":"sort results by this field","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"sortOrder","description":"sort order - 'asc' or 'des'. Default is asc","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"limit","description":"limit","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"offset","description":"offset","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"applicableDevicesForImage":{"type":"array","items":{"type":"object","properties":{"mdfId":{"type":"string","description":""},"productId":{"type":"array","items":{"type":"string"},"description":""},"productName":{"type":"string","description":""}}},"description":""},"applicationType":{"type":"string","description":""},"createdTime":{"type":"string","description":""},"extendedAttributes":{"type":"object","properties":{},"description":""},"family":{"type":"string","description":""},"feature":{"type":"string","description":""},"fileServiceId":{"type":"string","description":""},"fileSize":{"type":"string","description":""},"imageIntegrityStatus":{"type":"string","description":""},"imageName":{"type":"string","description":""},"imageSeries":{"type":"array","items":{"type":"string"},"description":""},"imageSource":{"type":"string","description":""},"imageType":{"type":"string","description":""},"imageUuid":{"type":"string","description":""},"importSourceType":{"type":"string","enum":["DEVICE","REMOTEURL","CCO","FILESYSTEM"],"description":""},"isTaggedGolden":{"type":"boolean","description":""},"md5Checksum":{"type":"string","description":""},"name":{"type":"string","description":""},"profileInfo":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":""},"extendedAttributes":{"type":"object","properties":{},"description":""},"memory":{"type":"integer","description":""},"productType":{"type":"string","description":""},"profileName":{"type":"string","description":""},"shares":{"type":"integer","description":""},"vCpu":{"type":"integer","description":""}}},"description":""},"shaCheckSum":{"type":"string","description":""},"vendor":{"type":"string","description":""},"version":{"type":"string","description":""}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetSoftwareImageDetailsResponse"}}}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"0c8f-7a0b-49b9-aedd","x-rapi-overview":"Returns software image list based on a filter criteria. For example: \"filterbyName = cat3k%\"","x-rapi-domain":"Site Management","x-rapi-subdomain":"Software Image Management (SWIM)","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/image/importation","x-rapi-publicPath":"/dna/intent/api/v1/image/importation","x-rapi-registerInKONG":true,"x-rapi-banner":["Sunset"],"__originalOperationId":"getSoftwareImageDetails","method":"get","path":"/dna/intent/api/v1/image/importation"}}