About

URL:: https://<root>/about
Methods:: GET
Child Resources:: Report
Version Introduced:: 11.5

Description

The about resource compiles information, such as hardware details (CPU, RAM, disk usage, etc.) and licenses, for each component that makes up an ArcGIS Enterprise deployment, including all servers federated with the deployment.

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 response are replaced with placeholder values. If set to `false`, or not included in the request, hostnames will be appear as-is in the response. Values: `true` \| `false`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

redact

(Optional)

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

Values: true | false

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the about resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/portaladmin/about?redact=true&f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "siteMap": {
    "summary": {
      "portal": [
        {
          "machines": ["REDACTED.example.com"],
          "totalCpu": 2,
          "totalRam": 15359
        }
      ],
      "servers": [
        {
          "machines": ["REDACTED.example.com"],
          "totalCpu": 8,
          "totalRam": 32456,
          "siteRole": "FEDERATED_SERVER"
        },
        {
          "machines": ["REDACTED.example.com"],
          "totalCpu": 8,
          "totalRam": 32456,
          "siteRole": "FEDERATED_SERVER"
        },
        {
          "machines": ["REDACTED.example.com"],
          "totalCpu": 2,
          "totalRam": 15359,
          "siteRole": "HOSTING_SERVER"
        },
        {
          "machines": ["REDACTED.example.com"],
          "totalCpu": 2,
          "totalRam": 15359,
          "siteRole": "FEDERATED_SERVER"
        }
      ],
      "dataStores": [
        {
          "machines": ["REDACTED.example.com"],
          "totalCpu": 2,
          "totalRam": 15359,
          "store": "graphStore"
        },
        {
          "machines": ["REDACTED.example.com"],
          "totalCpu": 2,
          "totalRam": 15359,
          "store": "objectStore"
        },
        {
Expand