Cisco Secure Firewall Updates API

openapi: 3.2.0
info:
  title: Cisco Secure Firewall Updates API
  version: 1.13.0
  contact:
    name: Cisco Firepower TAC
    email: ngfw-support@cisco.com
  description: 'Operations tagged Updates across 2 of this provider''s published API definitions: cdfmc-openapi.yaml, cisco-secure-firewall-cdfmc-openapi.yml.
    Each path carries the servers of the definition it was published in.'
  x-provenance:
    method: harvested
    first_party: true
    harvested: '2026-08-19'
    source: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml
    source_repo: https://github.com/CiscoDevNet/scc-public-api-docs
    note: Verbatim first-party OpenAPI published by Cisco in the CiscoDevNet scc-public-api-docs repository, the source of
      record for developer.cisco.com/docs/cisco-security-cloud-control-firewall-manager/. Not authored or modified by API
      Evangelist.
    derived_view: Per-tag view of cisco-secure-firewall-cdfmc-openapi.yml, the provider's source document. Operations and
      schemas are the provider's, unmodified; only the partition is ours.
    derived_from: cisco-secure-firewall-cdfmc-openapi.yml
    operation_coverage: 8/8
  x-evidence:
    fetched: '2026-08-19'
    url: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml
    http_status: 200
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
tags:
- name: Updates
paths:
  /v1/cdfmc/api/fmc_platform/v1/updates/cancelupgrades:
    post:
      deprecated: false
      description: '**Cancel a failed upgrade. _Check the response section for applicable examples (if any)._**'
      operationId: createCancelUpgrade
      requestBody:
        content:
          application/json:
            examples:
              'Example 1 : POST /api/fmc_platform/v1/updates/cancelupgrades ( Trigger cancel upgrade on the specified devices )':
                value:
                  targets:
                  - id: 1251b782-7922-11e8-85d1-9ce8632d3182
                    name: vFTD-1
                    type: Device
                  - id: 88f052b8-7922-11e8-a602-840c6cea8ca5
                    name: vFTD-2
                    type: Device
            schema:
              $ref: '#/components/schemas/CancelUpgrade'
              type: object
        description: The input representation of CancelUpgrade object model.
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                'Example 1 : POST /api/fmc_platform/v1/updates/cancelupgrades ( Trigger cancel upgrade on the specified devices )':
                  value:
                    metadata:
                      task:
                        id: '8589935884'
                        message: Triggered all Cancel Upgrades successfully
                        status: RUNNING
                    targets:
                    - id: 1251b782-7922-11e8-85d1-9ce8632d3182
                      name: vFTD-1
                      type: Device
                    - id: 88f052b8-7922-11e8-a602-840c6cea8ca5
                      name: vFTD-2
                      type: Device
                    type: CancelUpgrade
              schema:
                $ref: '#/components/schemas/CancelUpgrade'
                type: object
          description: Created
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Updates
    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
  /v1/cdfmc/api/fmc_platform/v1/updates/retryupgrades:
    post:
      deprecated: false
      description: '**Retry a failed upgrade. _Check the response section for applicable examples (if any)._**'
      operationId: createRetryUpgrade
      requestBody:
        content:
          application/json:
            examples:
              'Example 1 : POST /api/fmc_platform/v1/updates/retryupgrades ( Trigger retry upgrade on the specified devices )':
                value:
                  targets:
                  - id: 1251b782-7922-11e8-85d1-9ce8632d3182
                    name: vFTD-1
                    type: Device
                  - id: 88f052b8-7922-11e8-a602-840c6cea8ca5
                    name: vFTD-2
                    type: Device
            schema:
              $ref: '#/components/schemas/RetryUpgrade'
              type: object
        description: The input representation of RetryUpgrade object model.
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                'Example 1 : POST /api/fmc_platform/v1/updates/retryupgrades ( Trigger retry upgrade on the specified devices )':
                  value:
                    metadata:
                      task:
                        id: '8589935884'
                        message: Triggered all Retry Upgrades successfully
                        status: RUNNING
                    targets:
                    - id: 1251b782-7922-11e8-85d1-9ce8632d3182
                      name: vFTD-1
                      type: Device
                    - id: 88f052b8-7922-11e8-a602-840c6cea8ca5
                      name: vFTD-2
                      type: Device
                    type: RetryUpgrade
              schema:
                $ref: '#/components/schemas/RetryUpgrade'
                type: object
          description: Created
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Updates
    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
  /v1/cdfmc/api/fmc_platform/v1/updates/revertupgrades:
    post:
      deprecated: false
      description: '**Trigger reversion of an upgrade. _Check the response section for applicable examples (if any)._**'
      operationId: createRevertUpgrade
      requestBody:
        content:
          application/json:
            examples:
              'Example 1 : POST /api/fmc_platform/v1/updates/revertupgrades ( Trigger revert upgrade on the specified devices )':
                value:
                  targets:
                  - id: 1251b782-7922-11e8-85d1-9ce8632d3182
                    name: vFTD-1
                    type: Device
                  - id: 88f052b8-7922-11e8-a602-840c6cea8ca5
                    name: vFTD-2
                    type: Device
            schema:
              $ref: '#/components/schemas/RevertUpgrade'
              type: object
        description: The input representation of RevertUpgrade object model.
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                'Example 1 : POST /api/fmc_platform/v1/updates/revertupgrades ( Trigger revert upgrade on the specified devices )':
                  value:
                    metadata:
                      task:
                        id: '8589935884'
                        message: Triggered all Revert Upgrades successfully
                        status: RUNNING
                    targets:
                    - id: 1251b782-7922-11e8-85d1-9ce8632d3182
                      name: vFTD-1
                      type: Device
                    - id: 88f052b8-7922-11e8-a602-840c6cea8ca5
                      name: vFTD-2
                      type: Device
                    type: RevertUpgrade
              schema:
                $ref: '#/components/schemas/RevertUpgrade'
                type: object
          description: Created
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Updates
    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
  /v1/cdfmc/api/fmc_platform/v1/updates/upgradepackages:
    get:
      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
      - $ref: '#/components/parameters/offset'
        name: offset
      - $ref: '#/components/parameters/limit'
        name: limit
      - $ref: '#/components/parameters/expanded'
        name: 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.0
                        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.0
                        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.0
                        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.0
                        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:
                $ref: '#/components/schemas/UpgradePackageListContainer'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Updates
    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
  /v1/cdfmc/api/fmc_platform/v1/updates/upgradepackages/{containerUUID}/applicabledevices:
    get:
      deprecated: false
      description: '**Get the list of devices available for the specified upgrade package.**'
      operationId: getAllApplicableDevice
      parameters:
      - description: The container id under which this specific resource is contained.
        in: path
        name: containerUUID
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/offset'
        name: offset
      - $ref: '#/components/parameters/limit'
        name: limit
      - $ref: '#/components/parameters/expanded'
        name: expanded
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicableDeviceListContainer'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Updates
    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
  /v1/cdfmc/api/fmc_platform/v1/updates/upgradepackages/{objectId}:
    delete:
      deprecated: false
      description: '**Delete the upgrade package associated with the specified ID. _Check the response section for applicable
        examples (if any)._**'
      operationId: deleteUpgradePackage
      parameters:
      - description: Unique identifier of the upgrade package.
        in: path
        name: objectId
        required: true
        schema:
          type: string
      - description: Boolean for package type. If TRUE, delete the user configured pointer. If FALSE, delete the local bundle.
        in: query
        name: userConfiguredPointer
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              examples:
                ? 'Example 1 : DELETE /api/fmc_platform/v1/updates/upgradepackages/aaebb332-de68-11ef-9a96-abb007be7f1b9?userConfiguredPointer=true
                  ( Delete the Upgrade Package  by the upgrade package id. This operation will remove the upgrade package
                  from FMC. )'
                : value:
                    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.0
                      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
              schema:
                $ref: '#/components/schemas/UpgradePackage'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Updates
    get:
      deprecated: false
      description: '**Get the upgrade package associated with the specified ID.**'
      operationId: getUpgradePackage
      parameters:
      - description: Unique identifier of the object.
        in: path
        name: objectId
        required: true
        schema:
          type: string
      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.0
                        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.0
                        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 : GET /api/fmc_platform/v1/updates/upgradepackages/aaebb332-de68-11ef-9a96-abb007be7f1b ( Test
                  Get of Upgrade Packages )'
                : value:
                    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.0
                      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
              schema:
                $ref: '#/components/schemas/UpgradePackage'
                type: object
          description: OK
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                type: object
          description: Error
      tags:
      - Updates
    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
  /v1/cdfmc/api/fmc_platform/v1/updates/upgrades:
    post:
      deprecated: false
      description: '**Create a task to trigger a Threat Defense upgrade/readiness check on a list of devices or push an upgrade
        file to a list of devices. If neither pushUpgradeFileOnly nor readinessCheckOnly is set, execute upgrade on the device.
        _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.
        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:
              $ref: '#/components/schemas/Upgrade'
              type: object
        description: The input representation of Upgrade object model.
        required: true
      responses:
    

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-secure-firewall/refs/heads/main/openapi/cisco-secure-firewall-updates-api-openapi.yml