Create Upgrade - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Create Upgrade","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":"**Create a task to trigger a Threat Defense upgrade task for a list of devices. If only pushUpgradeFileOnly is TRUE, the task is to stage the upgrade. If readinessCheckOnly is TRUE the task is to run a readiness check but not perform the upgrade even if pushUpgradeFileOnly is TRUE. If neither pushUpgradeFileOnly nor readinessCheckOnly are TRUE then this will initiate the upgrade. _Check the response section for applicable examples (if any)._**","operationId":"createUpgrade","parameters":[{"description":"Boolean for Snort version. When TRUE the device is set to Snort3, when FALSE the device is set to Snort2.","in":"query","name":"toggleToSnort3","required":false,"schema":{"type":"boolean"}},{"description":"Boolean for upgrade revert. When TRUE backups are made so that the device may be reverted to the pre-upgrade version following an upgrade. When FALSE revert is not enabled for the device. By default this is TRUE. This option is not applicable to Hotfixes, for a Hotfix upgrade this option must be explicitly set to FALSE.","in":"query","name":"enableUpgradeRevert","required":false,"schema":{"type":"boolean"}},{"description":"Boolean for auto upgrade cancel. When TRUE the upgrade is automatically cancelled and the device rolled back to the previous version (if possible) if the upgrade fails. When FALSE if the upgrade fails the device remains in the failed state and will not be automatically rolled back. By default this is FALSE. This option is not applicable to Patches or Hotfixes.","in":"query","name":"autoUpgradeCancel","required":false,"schema":{"type":"boolean"}},{"description":"Boolean for readiness check. When TRUE run readiness check for the upgrade package on a list of devices. Not compatible with pushUpgradeFileOnly option, this option will override pushUpgradeFileOnly.","in":"query","name":"readinessCheckOnly","required":false,"schema":{"type":"boolean"}},{"description":"Boolean for upgrade file push. When TRUE push the upgrade file to a list of devices. Not compatible with readinessCheckOnly option.","in":"query","name":"pushUpgradeFileOnly","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_platform/v1/updates/upgrades ( Push the specified upgrade package on the specified devices )":{"value":{"pushUpgradeFileOnly":"true","targets":[{"id":"1251b782-7922-11e8-85d1-9ce8632d3182","name":"vFTD-1","type":"Device"},{"id":"88f052b8-7922-11e8-a602-840c6cea8ca5","name":"vFTD-2","type":"Device"}],"upgradePackage":{"id":"73207350-8395-11e8-845b-e5a3cc8a21de","type":"UpgradePackage"}}},"Example 2 : POST /api/fmc_platform/v1/updates/upgrades ( Trigger the specified upgrade on the specified devices )":{"value":{"pushUpgradeFileOnly":"false","targets":[{"id":"1251b782-7922-11e8-85d1-9ce8632d3182","name":"vFTD-1","type":"Device"},{"id":"88f052b8-7922-11e8-a602-840c6cea8ca5","name":"vFTD-2","type":"Device"}],"upgradePackage":{"id":"73207350-8395-11e8-845b-e5a3cc8a21de","type":"UpgradePackage"}}},"Example 3 : POST /api/fmc_platform/v1/updates/upgrades ( Trigger readiness check on the specified devices )":{"value":{"readinessCheckOnly":"true","targets":[{"id":"1251b782-7922-11e8-85d1-9ce8632d3182","name":"vFTD-1","type":"Device"},{"id":"88f052b8-7922-11e8-a602-840c6cea8ca5","name":"vFTD-2","type":"Device"}],"upgradePackage":{"id":"73207350-8395-11e8-845b-e5a3cc8a21de","type":"UpgradePackage"}}}},"schema":{"type":"object","description":"This API is to trigger an upgrade/readinesscheck on a list of devices or just push an upgrade file to a list of devices.","properties":{"autoUpgradeCancel":{"description":"If set to True, the upgrade will be automatically canceled and go back to the original starting point upon an upgrade failure, otherwise the device will stay at the current state where it failed.","type":"boolean"},"description":{"description":"More information about the upgrade.","type":"string"},"enableUpgradeRevert":{"type":"boolean"},"id":{"description":"Unique ID of this operation.","type":"string"},"links":{"description":"Object representing this resource.","type":"object","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":{"description":"Object representing metadata attributes for the triggered task.","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":{"description":"Name of the upgrade.","type":"string"},"pushUpgradeFileOnly":{"description":"Set to True if pushing the upgrade file to device(s) only, otherwise actual upgrade will also be triggered. When both readinessCheckOnly and pushUpgradeFileOnly are set to true, readinessCheckOnly will take the precedence.","type":"boolean"},"readinessCheckOnly":{"description":"Set to True if performing readiness check only, otherwise the device will start a real upgrade procedure. When both readinessCheckOnly and pushUpgradeFileOnly are set to true, readinessCheckOnly will take the precedence.","type":"boolean"},"targets":{"description":"A list of FTD devices.","items":{"type":"object","description":"This is the target device.","properties":{"description":{"type":"string"},"id":{"description":"Unique ID of the device.","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":{"description":"Name of the device.","type":"string"},"type":{"description":"Device","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ITarget"},"type":"array"},"troubleshootGeneration":{"description":"Boolean value indicating whether to generate troubleshooting information during the upgrade.","type":"boolean"},"type":{"description":"Upgrade","type":"string"},"upgradePackage":{"description":"Object representing the upgrade package.","type":"object","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"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/Upgrade"}}},"description":"The input representation of Upgrade object model.","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"Example 1 : POST /api/fmc_platform/v1/updates/upgrades ( Push the specified upgrade package on the specified devices )":{"value":{"metadata":{"task":{"id":"8589935884","message":"Triggered all upgrade staging successfully.","status":"RUNNING"}},"pushUpgradeFileOnly":"true","targets":[{"id":"1251b782-7922-11e8-85d1-9ce8632d3182","name":"vFTD-1","type":"Device"},{"id":"88f052b8-7922-11e8-a602-840c6cea8ca5","name":"vFTD-2","type":"Device"}],"type":"Upgrade","upgradePackage":{"id":"73207350-8395-11e8-845b-e5a3cc8a21de","type":"UpgradePackage"}}},"Example 2 : POST /api/fmc_platform/v1/updates/upgrades ( Trigger the specified upgrade on the specified devices )":{"value":{"metadata":{"task":{"id":"8589935884","message":"Triggered all upgrades successfully.","status":"RUNNING"}},"pushUpgradeFileOnly":"false","targets":[{"id":"1251b782-7922-11e8-85d1-9ce8632d3182","name":"vFTD-1","type":"Device"},{"id":"88f052b8-7922-11e8-a602-840c6cea8ca5","name":"vFTD-2","type":"Device"}],"type":"Upgrade","upgradePackage":{"id":"73207350-8395-11e8-845b-e5a3cc8a21de","type":"UpgradePackage"}}},"Example 3 : POST /api/fmc_platform/v1/updates/upgrades ( Trigger readiness check on the specified devices )":{"value":{"metadata":{"task":{"id":"8589935884","message":"Triggered all readiness checks successfully.","status":"RUNNING"}},"pushUpgradeFileOnly":"false","targets":[{"id":"1251b782-7922-11e8-85d1-9ce8632d3182","name":"vFTD-1","type":"Device"},{"id":"88f052b8-7922-11e8-a602-840c6cea8ca5","name":"vFTD-2","type":"Device"}],"type":"Upgrade","upgradePackage":{"id":"73207350-8395-11e8-845b-e5a3cc8a21de","type":"UpgradePackage"}}}},"schema":{"type":"object","description":"This API is to trigger an upgrade/readinesscheck on a list of devices or just push an upgrade file to a list of devices.","properties":{"autoUpgradeCancel":{"description":"If set to True, the upgrade will be automatically canceled and go back to the original starting point upon an upgrade failure, otherwise the device will stay at the current state where it failed.","type":"boolean"},"description":{"description":"More information about the upgrade.","type":"string"},"enableUpgradeRevert":{"type":"boolean"},"id":{"description":"Unique ID of this operation.","type":"string"},"links":{"description":"Object representing this resource.","type":"object","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":{"description":"Object representing metadata attributes for the triggered task.","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":{"description":"Name of the upgrade.","type":"string"},"pushUpgradeFileOnly":{"description":"Set to True if pushing the upgrade file to device(s) only, otherwise actual upgrade will also be triggered. When both readinessCheckOnly and pushUpgradeFileOnly are set to true, readinessCheckOnly will take the precedence.","type":"boolean"},"readinessCheckOnly":{"description":"Set to True if performing readiness check only, otherwise the device will start a real upgrade procedure. When both readinessCheckOnly and pushUpgradeFileOnly are set to true, readinessCheckOnly will take the precedence.","type":"boolean"},"targets":{"description":"A list of FTD devices.","items":{"type":"object","description":"This is the target device.","properties":{"description":{"type":"string"},"id":{"description":"Unique ID of the device.","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":{"description":"Name of the device.","type":"string"},"type":{"description":"Device","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ITarget"},"type":"array"},"troubleshootGeneration":{"description":"Boolean value indicating whether to generate troubleshooting information during the upgrade.","type":"boolean"},"type":{"description":"Upgrade","type":"string"},"upgradePackage":{"description":"Object representing the upgrade package.","type":"object","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"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/Upgrade"}}},"description":"Created"},"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":"createUpgrade","method":"post","path":"/v1/cdfmc/api/fmc_platform/v1/updates/upgrades"}}