Initializing help system before first use

# xpressinsight.scenario.InsightRestClient.upgrade_app

Purpose
Upgrade an existing app.
Synopsis
`xpressinsight.scenario.InsightRestClient.upgrade_app(self, app_id: str, app_file: str | BinaryIO, partial_upgrade: bool = False, validate_model_name: bool = False, wait_for_completion: bool = True) -> Optional[scenario.AppUpgradeResponse]`
Arguments

app_id | The ID of the app to be upgraded.
app_file | Either the filename of the application .zip file, or a BinaryIO from which the application .zip data will be read. This should be a complete replacement for the existing app unless partial_upgrade=True.
partial_upgrade | If True, the supplied .zip file need only contain the files that have modified. Files from the original app not included in this zipfile are retained unchanged. If False, the .zip file is a complete replacement for the existing app, and any files not included in the new .zip file are removed from the Insight server.
validate_model_name | If True, validate that the model name in the supplied .zip file matches the model name of the existing app in the Insight server.
wait_for_completion | If True, the function does not return until the upgrade has completed. If False, the function returns immediately after upgrade is accepted by the Insight server (which might be before the app upgrade has completed).

Return value

Information about the app upgrade; this is not available if wait_for_completion=False.

This function may raise the following errors:

scenario.InsightServerError

  If there is an issue communicating with the Insight server.

Example

    >>> with ins.InsightRestClient(insight_url='http://localhost:8080/') as client:
    ...     upgrade_response = client.upgrade_app(
    ...        '570b9100-46e3-4643-baee-2e24aa538f25', 'new_app.zip')
    ...     print(f'App upgrade completed')
    ...     for msg in upgrade_response.messages:
    ...         print(f'  {msg}')

Further information
The method upgrade_app is part of the class xpressinsight.scenario.InsightRestClient.
Related topics
scenario.AppUpgradeResponse
Parent Topic Insight Scenario REST API client

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.