Reports REST API

Considering 8090 as the AppNode port, this section describes the following Reports REST APIs:

http://localhost:8090/monitor/reports

 
Method GET
Description Get a list of reports
Path Parameters None
Query Parameters None
Header Parameters None
Output
  • Code = 200

    Message = "Returns a list of reports."

  • Code = 503

    Message = "Internal Server Error".
Sample Output [

{ "id": "Report-2021-08-26T12-56-50-0700", "date": "2021-08-26 12:56:50" },

{ "id": "Report-2021-08-26T16-42-14-0700", "date": "2021-08-26 16:42:14" }

]

 

http://localhost:8090/monitor/reports/generate

 
Method GET
Description Generate a report manually
Path Parameters None
Query Parameters
  • Parameter: engineData

  • Type: Boolean(Optional)

  • Description: Whether to generate a APPNODE_DATA file in the report zip file. By default, the value is false.
Header Parameters None
Output
  • Code = 200

    Message = "Reports are generated."

  • Code = 503

    Message = "Internal Server Error".
Sample Output {

"code": "200",

"message": "Reports are generated.",

"status": "success"

}

http://localhost:8090/monitor/reports/{reportId}/download

 
Method GET
Description Download a report zip file.
Path Parameters
  • Parameter: reportId

  • Type: String (required)

  • Description: The id of a report
Query Parameters None
Header Parameters None
Output
  • Code = 200

    Message = "Download a report zip file."

  • Code = 503

    Message = "Internal Server Error".
Sample Output {

"code": "200",

"message": "Reports are generated.",

"status": "success"

}

http://localhost:8090/monitor/reports/{reportId}/delete

 
Method GET
Description Delete a report.
Path Parameters
  • Parameter: reportId

  • Type: String (required)

  • Description: The id of a report
Query Parameters None
Header Parameters None
Output
  • Code = 200

    Message = "Delete a report."

  • Code = 503

    Message = "Internal Server Error".
Sample Output {

"code": "200",

"message": "Report is deleted.",

"status": "success"

}

http://localhost:8090/monitor/reports/deleteall

 
Method GET
Description Delete all reports.
Path Parameters None
Query Parameters None
Header Parameters None
Output
  • Code = 200

    Message = "Reports are deleted."

  • Code = 503

    Message = "Internal Server Error".
Sample Output {

"code": "200",

"message": "Reports are deleted.",

"status": "success"

}