POST /api/v3/me/upgrade

Runs pre-login system upgrade and initialization actions

UpgradeV3
Use this endpoint to ensure the database and system configuration are up to date with the latest application code. By default, runs all pre-load actions (upgrades + report installation) for maximum compatibility. Set upgradesOnly=true to limit to schema upgrades for faster execution.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type, including the request body.

Query Parameters

Name Description Type Required
upgradesOnly When true, limits to system data upgrades only (faster but may not guarantee full compatibility). When false (default), runs all pre-load actions including report installation. boolean Optional

Responses

200 OK The request succeeded and the response body contains the requested data.