Get All Upgrade Package - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Upgrade Package","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get the list of all upgrade packages.**","operationId":"getAllUpgradePackage","parameters":[{"description":"Exclude packages from support site and only show local packages.","in":"query","name":"excludeSupportSite","required":false,"schema":{"type":"boolean"}},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GETALL /api/fmc_platform/v1/updates/upgradepackages ( Test Get of Upgrade Packages )":{"value":{"items":[{"id":"aaebb332-de68-11ef-9a96-abb007be7f1b","links":{"self":"https://example.cisco.com/api/fmc_platform/v1/updates/upgradepackages/aaebb332-de68-11ef-9a96-abb007be7f1b"},"metadata":{"fileSize":1319180,"isSuggestedRelease":true,"modelNumber":"75","packageAvailability":{"availableOnSupportSite":true,"bundleAvailableLocally":false,"directPullSupported":true,"userConfiguredPointer":true},"rebootRequired":true,"updateVersion":"7.4.2-172","upgradeFileId":"Cisco FTD Upgrade / Mon Jul 29 21:56:41 UTC 2024","upgradeFileName":"Cisco_FTD_Upgrade-7.4.2-172.sh.REL.tar","upgradeFrom":"7.0.0","upgradeType":"Cisco FTD Upgrade","uploadDate":"2024-07-29T21:56:41Z"},"name":"Cisco_FTD_Upgrade-7.4.2-172.sh.REL.tar","type":"UpgradePackage"},{"id":"aaec00c6-de68-11ef-9a96-abb007be7f1b","links":{"self":"https://example.cisco.com/api/fmc_platform/v1/updates/upgradepackages/aaec00c6-de68-11ef-9a96-abb007be7f1b"},"metadata":{"fileSize":1527590,"isSuggestedRelease":false,"modelNumber":"75","packageAvailability":{"availableOnSupportSite":true,"bundleAvailableLocally":false,"directPullSupported":true,"userConfiguredPointer":false},"rebootRequired":true,"updateVersion":"7.6.0-113","upgradeFileId":"Cisco FTD Upgrade / Fri Sep 13 02:45:00 UTC 2024","upgradeFileName":"Cisco_FTD_Upgrade-7.6.0-113.sh.REL.tar","upgradeFrom":"7.1.0","upgradeType":"Cisco FTD Upgrade","uploadDate":"2024-09-13T02:45:00Z"},"name":"Cisco_FTD_Upgrade-7.6.0-113.sh.REL.tar","type":"UpgradePackage"}],"links":{"self":"https://example.cisco.com/api/fmc_platform/v1/updates/upgradepackages"},"paging":{"count":4,"limit":4,"offset":0,"pages":1}}},"Example 2 : GETALL /api/fmc_platform/v1/updates/upgradepackages ( Test Get of Upgrade Packages )":{"value":{"items":[{"id":"aaebb332-de68-11ef-9a96-abb007be7f1b","links":{"self":"https://example.cisco.com/api/fmc_platform/v1/updates/upgradepackages/aaebb332-de68-11ef-9a96-abb007be7f1b"},"metadata":{"fileSize":1319180,"isSuggestedRelease":true,"modelNumber":"75","packageAvailability":{"availableOnSupportSite":true,"bundleAvailableLocally":false,"directPullSupported":true,"userConfiguredPointer":true},"rebootRequired":true,"updateVersion":"7.4.2-172","upgradeFileId":"Cisco FTD Upgrade / Mon Jul 29 21:56:41 UTC 2024","upgradeFileName":"Cisco_FTD_Upgrade-7.4.2-172.sh.REL.tar","upgradeFrom":"7.0.0","upgradeType":"Cisco FTD Upgrade","uploadDate":"2024-07-29T21:56:41Z"},"name":"Cisco_FTD_Upgrade-7.4.2-172.sh.REL.tar","type":"UpgradePackage"},{"id":"aaec00c6-de68-11ef-9a96-abb007be7f1b","links":{"self":"https://example.cisco.com/api/fmc_platform/v1/updates/upgradepackages/aaec00c6-de68-11ef-9a96-abb007be7f1b"},"metadata":{"fileSize":1527590,"isSuggestedRelease":false,"modelNumber":"75","packageAvailability":{"availableOnSupportSite":true,"bundleAvailableLocally":false,"directPullSupported":true,"userConfiguredPointer":false},"rebootRequired":true,"updateVersion":"7.6.0-113","upgradeFileId":"Cisco FTD Upgrade / Fri Sep 13 02:45:00 UTC 2024","upgradeFileName":"Cisco_FTD_Upgrade-7.6.0-113.sh.REL.tar","upgradeFrom":"7.1.0","upgradeType":"Cisco FTD Upgrade","uploadDate":"2024-09-13T02:45:00Z"},"name":"Cisco_FTD_Upgrade-7.6.0-113.sh.REL.tar","type":"UpgradePackage"}],"links":{"self":"https://example.cisco.com/api/fmc_platform/v1/updates/upgradepackages"},"paging":{"count":4,"limit":4,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","properties":{"description":{"type":"string"},"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/UpgradePackage"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/UpgradePackageListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Updates"],"__originalOperationId":"getAllUpgradePackage","method":"get","path":"/v1/cdfmc/api/fmc_platform/v1/updates/upgradepackages"}}