Get Device Upgrade Runs - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Device Upgrade Runs","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"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":{"description":"Get a list of device upgrade runs in the SCC Firewall Manager Tenant. Each upgrade run represents a group of devices being upgraded, or staged for upgrades, together.","operationId":"getDeviceUpgradeRuns","parameters":[{"description":"Number of results to retrieve.","in":"query","name":"limit","required":false,"schema":{"maximum":200,"minimum":0,"type":"string"}},{"description":"Offset of the results retrieved. The Security Cloud Control APIs use the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"string"}},{"description":"The query to execute. Use the Lucene Query Syntax to construct your query.","example":"fieldName:fieldValue","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"The fields to sort results by.","example":"name:DESC","in":"query","name":"sort","required":false,"schema":{"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int32","type":"integer"},"items":{"description":"The list of items retrieved.","items":{"properties":{"deviceUids":{"description":"The set of device UIDs that are part of this upgrade run.","example":["7131daad-e813-4b8f-8f42-be1e241e8cdb","5141daad-e813-4b8f-8f42-be1e241e8cdb"],"items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true},"deviceUpgradeStatuses":{"description":"The current status of each device in the upgrade run.","items":{"properties":{"completionStatuses":{"description":"The completion status of the upgrade on the device. For HA pairs or clusters, there will be multiple completion statuses; one per node of the pair or cluster.","items":{"properties":{"message":{"description":"A message, indicating current progress, returned from the device.","type":"string"},"name":{"description":"The name of the device. Note: this will be the name of the node on the cdFMC if the device is part of an HA pair or cluster.","type":"string"},"nodeType":{"description":"(HA Pairs and clusters only) The node type of the device.","enum":["HA_PRIMARY","HA_SECONDARY","CLUSTER_CONTROL","CLUSTER_DATA"],"type":"string"},"percentageComplete":{"description":"The percentage completion of the current task being performed","format":"double","type":"number"}},"type":"object","$$ref":"#/components/schemas/CompletionStatusDto"},"type":"array"},"uid":{"description":"The unique identifier, represented as a UUID, of the device in SCC Firewall Manager.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/DeviceUpgradeStatusDto"},"type":"array"},"name":{"description":"The name of the upgrade run. Upgrade runs names are unique in a tenant in SCC Firewall Manager.","example":"my-example-device","type":"string"},"stageUpgradeOnly":{"description":"Indicates if this upgrade run is to stage the upgrade on the device. If set to true, the upgrade is not applied on the device.","example":true,"type":"boolean"},"transactionUid":{"description":"The unique identifier of the CDO transaction that tracks this upgrade run.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the device upgrade run in SCC Firewall Manager.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"upgradePackageUid":{"description":"(cdFMC-managed FTD device upgrades only) The unique identifier of the upgrade package being used.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"upgradeRunStatus":{"description":"The current status of the upgrade run.","enum":["UPLOADING_IMAGE","PERFORMING_READINESS_CHECK","UPGRADE_STAGED","UPGRADE_STAGING_FAILED","UGPRADE_STAGING_FAILED","PERFORMING_UPGRADE","UPGRADE_COMPLETED","UPGRADE_FAILED"],"example":"UPGRADE_COMPLETED","type":"string"},"upgradeRunType":{"description":"The type of the upgrade run","enum":["ASA_DEVICE_UPGRADE","FTD_DEVICE_UPGRADE","FTD_SECURE_CLIENT_UPGRADE","ASA_SECURE_CLIENT_UPGRADE"],"example":"ASA_DEVICE_UPGRADE","type":"string"}},"type":"object","$$ref":"#/components/schemas/UpgradeRunDto"},"type":"array"},"limit":{"description":"The number of results retrieved.","example":50,"format":"int32","type":"integer"},"offset":{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","example":0,"format":"int32","type":"integer"}},"type":"object","$$ref":"#/components/schemas/FtdUpgradeRunDtoPage"}}},"description":"List of Device Upgrade Run objects"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get Device Upgrade Runs","tags":["Device Upgrades"],"__originalOperationId":"getDeviceUpgradeRuns","method":"get","path":"/v1/inventory/devices/upgrades/runs"}}