{"type":"api","title":"Returns list of software images","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":"returnsListOfSoftwareImages","tags":["Software Image Management (SWIM)"],"summary":"Returns list of software images","deprecated":false,"description":"A list of available images for the specified site is provided. The default value of the site is set to global. The list includes images that have been imported onto the disk, as well as the latest and suggested images from Cisco.com. ","parameters":[{"name":"siteId","description":"Site identifier to get the list of all available products under the site. The default value is the global site. See https://developer.cisco.com/docs/dna-center/get-site for `siteId`","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"productNameOrdinal","description":"The product name ordinal is a unique value for each network device product. The productNameOrdinal can be obtained from the response of API `/dna/intent/api/v1/siteWiseProductNames`","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"supervisorProductNameOrdinal","description":"The supervisor engine module ordinal is a unique value for each supervisor module. The `supervisorProductNameOrdinal` can be obtained from the response of API `/dna/intent/api/v1/siteWiseProductNames`","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"imported","description":"When the value is set to `true`, it will include physically imported images. Conversely, when the value is set to `false`, it will include image records from the cloud. The identifier for cloud images can be utilized to download images from Cisco.com to the disk.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"name","description":"Filter with software image or add-on name. Supports partial case-insensitive search. A minimum of 3 characters is required for the search.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"version","description":"Filter with image version. Supports partial case-insensitive search. A minimum of 3 characters is required for the search.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"golden","description":"When set to `true`, it will retrieve the images marked as tagged golden. When set to `false`, it will retrieve the images marked as not tagged golden.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"integrity","description":"Filter with verified images using Integrity Verification Available values: UNKNOWN, VERIFIED","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"hasAddonImages","description":"When set to `true`, it will retrieve the images which have add-on images. When set to `false`, it will retrieve the images which do not have add-on images.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"isAddonImages","description":"When set to `true`, it will retrieve the images that an add-on image. When set to `false`, it will retrieve the images that are not add-on images","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"offset","description":"The first record to show for this page; the first record is numbered 1. The minimum value is 1.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"The number of records to show for this page. The minimum and maximum values are 1 and 500, respectively.","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Software image identifier"},"imported":{"type":"boolean","description":"Flag for image info whether it is imported image or cloud image"},"name":{"type":"string","description":"Name of the software image"},"version":{"type":"string","description":"Software image version"},"imageType":{"type":"string","enum":["SYSTEM","SMU","SUBPACKAGE","PSIRT_SMU","APSP","APDP","ROMMON_SW"],"description":"Software image type"},"recommended":{"type":"string","enum":["CISCO","UNKNOWN"],"description":"CISCO if the image is recommended from Cisco.com"},"ciscoLatest":{"type":"boolean","description":"`true` if the image is latest/suggested from Cisco.com"},"integrityStatus":{"type":"string","enum":["VERIFIED","UNKNOWN"],"description":"Image Integrity verification status with Known Good Verification"},"isAddonImage":{"type":"boolean","description":"The value of `true` will indicate the image as an add-on image, while the value of `false` will indicate software image"},"hasAddonImages":{"type":"boolean","description":"Software images that have an applicable list of add-on images. The value of `true` will return software images with add-on images, while the value of `false` will return software images without add-on images"},"goldenTaggingDetails":{"type":"array","items":{"type":"object","properties":{"deviceRoles":{"type":"array","items":{"type":"string"},"description":"Golden tagging based on the device roles"},"deviceTags":{"type":"array","items":{"type":"string"},"description":"Golden tagging based on the device tags"},"inheritedSiteId":{"type":"string","description":"The Site Id of the site that this setting is inherited from."},"inheritedSiteName":{"type":"string","description":"The name of the site that this setting is inherited from"}}},"description":""},"productNames":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Product name ordinal is unique value for each network device product"},"productName":{"type":"string","description":"Network device product name"},"productNameOrdinal":{"type":"number","description":"Product name ordinal is unique value for each network device product"},"supervisorProductName":{"type":"string","description":"Name of the Supervisor Engine Module, supported by the `productName`. Example: The `Cisco Catalyst 9404R Switch` chassis is capable of supporting different supervisor engine modules: the `Cisco Catalyst 9400 Supervisor Engine-1`, the `Cisco Catalyst 9400 Supervisor Engine-1XL`, the `Cisco Catalyst 9400 Supervisor Engine-1XL-Y`, etc."},"supervisorProductNameOrdinal":{"type":"number","description":"Supervisor Engine Module Ordinal, supported by the `productNameOrdinal`. Example: The `286315691` chassis ordinal is capable of supporting different supervisor engine module ordinals: `286316172`, `286316710`, `286320394` etc."}}},"description":""},"isGoldenTagged":{"type":"boolean","description":"The value of `true` will indicate the image marked as golden, while the value of `false` will indicate the image not marked as golden"}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/ReturnsListOfSoftwareImagesResponse"}}}},"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":{}},"406":{"description":"The client requested a response in a content format that this server does not support.","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":{}},"502":{"description":"The server is (temporarily) unavailable.","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":"e4a3-6a8c-48fa-91ea","x-rapi-overview":"A list of available images for the specified site is provided. The default value of the site is set to global. The list includes images that have been imported onto the disk, as well as the latest and suggested images from Cisco.com. ","x-rapi-domain":"Site Management","x-rapi-subdomain":"Software Image Management (SWIM)","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/images","x-rapi-publicPath":"/dna/intent/api/v1/images","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"returnsListOfSoftwareImages","method":"get","path":"/dna/intent/api/v1/images"}}