Report

URL:: https://<root>/about/report
Methods:: POST
Version Introduced:: 11.5

Description

The report operation generates and downloads a .json file that contains the hardware and licensing information for each component of an Enterprise component. The information included in the report is the same information returned by the About resource compiled into a single file.

Request parameters

Parameter Details

Parameter	Details
`redact` (Optional)	When set to `true`, all hostnames included as part of URLs, or as values for the `machineName` properties, included in the report are replaced with placeholder values. If set to `false`, or not included in the request, hostnames will be appear as-is in the report. Values: `true` \| `false`

redact

(Optional)

When set to true, all hostnames included as part of URLs, or as values for the machineName properties, included in the report are replaced with placeholder values. If set to false, or not included in the request, hostnames will be appear as-is in the report.

Values: true | false

Example usage

The following is a sample POST request for the report operation:

Use dark colors for code blocksCopy
POST /<context>/portaladmin/about/report HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

redact=true