About | ArcGIS REST APIs | Esri Developer

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

Access requirements

Required privileges

The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Security and Infrastructure Organization Website

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.

Learn how to generate a token

Description

The about resource compiles and returns information for each component that makes up an ArcGIS Enterprise deployment — Portal for ArcGIS, ArcGIS Server, and ArcGIS Data Store. This resource returns both a high-level overview of the organization (including machine information, the role for each federated server, recently created backups for organizations using ArcGIS Enterprise 12.0 or later, and the data store type for each configured data store) and an in-depth look at each component.

The tabs below outline the detailed information returned for each component:

The following information is returned for Portal for ArcGIS:

ArcGIS Enterprise version and build information
Hardware information for each portal machine
Organization user type, app, extension, and capability licenses
Installed patches, including the install date and patch name (introduced at ArcGIS Enterprise 12.0)

Use dark colors for code blocksCopy
{
  //...
  "portal": {
    "lastUpdated": 1756158490891,
    "organizationUrl": "https://organization.example.com/gis",
    "currentBuild": "58722",
    "currentVersion": "12.0.0",
    "machines": [
      {
        "machineName": "ORGANIZATION.EXAMPLE.COM",
        "adminURL": "https://organization.example.com:7443/arcgis",
        "role": "",
        "webServerCertificateAlias": "esri_wildcard_202508250221",
Expand

The following information is returned for each ArcGIS Server federated with the organization:

ArcGIS Enterprise version and build information
Server role
Server function
Hardware information for each federated server
Server role, extension, and capability licenses
Installed patches, including the install date and patch name (introduced at ArcGIS Enterprise 12.0)

Use dark colors for code blocksCopy
{
  //...
  "serverSites": [
    {
      "lastUpdated": 1756158491205,
      "serverId": "0vE45WdCmBtOBl18",
      "webContextUrl": "",
      "siteUrl": "https://servermachineNB.example.com/gis",
      "serverType": "ARCGIS_NOTEBOOK_SERVER",
      "serverRole": "FEDERATED_SERVER",
      "serverFunction": "NotebookServer",
      "currentBuild": "58722",
      "currentVersion": "12.0.0",
Expand

The following information is returned for each configured ArcGIS Data Store

ArcGIS Enterprise version and build information
Hardware information for the machine running ArcGIS Data Store
The type of data store
Installed patches, including the install date and patch name (introduced at ArcGIS Enterprise 12.0)

Use dark colors for code blocksCopy
{
  //...
  "dataStores": [
    {
      "store": "graphStore, objectStore, relational, spatioTemporal",
      "currentVersion": "12.0.0",
      "currentBuild": "58722",
      "machines": [
        {
          "machineName": "DATASTOREMACHINE.EXAMPLE.COM",
          "hardware": {
            "cpu": "Intel(R) Xeon(R) Gold 6342 CPU @ 2.80GHz\n 2 physical CPU package(s)\n 2 physical CPU core(s)\n 2 logical CPU(s)\nIdentifier: Intel64 Family 6 Model 79 Stepping 0\nProcessorID: 0F8BFBFF000406F0\nMicroarchitecture: Broadwell (Server)",
            "os": "Microsoft Windows Server 2019 build 17763",
Expand

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 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 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 with redacted values:

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