Endpoint

/v2/upgrade/verify-image

POST

Verify that the given image can be used to upgrade the cluster and retrieve details about the upgrade that will occur.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_verify_request",
  "type": "object",
  "properties": {
    "image_path": {
      "description": "image_path",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "upgrade_verify_result",
  "type": "object",
  "properties": {
    "target_version": {
      "description": "target_version",
      "type": "string"
    },
    "upgrade_type": {
      "type": "string",
      "enum": [
        "SOFTWARE_ONLY",
        "SOFTWARE_AND_PLATFORM"
      ],
      "description": "upgrade_type:\n * `SOFTWARE_AND_PLATFORM` - SOFTWARE_AND_PLATFORM,\n * `SOFTWARE_ONLY` - SOFTWARE_ONLY"
    },
    "error": {
      "description": "error",
      "type": "string"
    }
  }
}