HTTP request

POST /api/fdm/v6/action/upgrade

Query Parameters

Parameter Required Type Description
cancelOnFailure False boolean A Boolean value, TRUE or FALSE. This parameter is optional and its default value is defined in UpgradeFile API. TRUE value indicates that this action will install the upgrade image and will perform the restoration operation to get to the state before the upgrade if the upgrade fails. FALSE value indicates that this action will install the upgrade image and will stop if the upgrade fails.

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    "https://${HOST}:${PORT}/api/fdm/v6/action/upgrade"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def start_upgrade(client, body):
    return client.Upgrade.startUpgrade(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {}

    start_upgrade(client, body)