Upgrade_Status.adoc

Installer - General - Upgrade Status

Get the status of a gateway or Energy Management Unit (EMU) upgrade.

Table of Contents

• Introduction
• Request
• Response
  • Root
  • Message_params Object
• Examples
  • Get Gateway Upgrade Status

Introduction

Enphase-API is an unofficial project providing an API wrapper and the documentation for Enphase®'s products and services.

More details on the project are available from the project’s homepage.

Request

A HTTP GET to the /installer/upgrade_status endpoint provides the following response data.

As of recent Gateway software versions this request requires user authentication and authorisation, see Authentication.

Response

Root

Name	Type	Values	Description
status_code	Number	Number	The status code.
reason_code	Number	Number	The reason code.
message_key	String	String	The message key.
message_params	Object	Message_params object	The message parameters.
timestamp	Number	Number	The epoch date and time the message was generated.
serial_num	String	String	The serial number of the Gateway (formerly "Envoy").

Message_params Object

Name	Type	Values	Description

Examples

Get Gateway Upgrade Status

GET /installer/upgrade_status Response

{"status_code": 200, "reason_code": 2200, "message_key": "task.emu_upgrade.finished_successful", "message_params": {}, "timestamp": 1679574816, "serial_num": "123456789101"}