About | ArcGIS REST APIs | Esri Developer

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

Access requirements

Required privileges

The Enterprise 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

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise 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 Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The about resource resource compiles information to create a high-level overview of the different aspects of a ArcGIS Enterprise on Kubernetes deployment. Information returned by this resource includes data store details, licenses, and enabled architecture profiles, as well as information for any servers federated with the deployment.

Request parameters

Parameter Details

Parameter	Details
`redact` (Optional)	When set to `true`, all hostnames included as part of URLs 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 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>/admin/about?redact=true&f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "currentBuild": "6702",
  "dataStores": [
    {
      "provider": "ArcGIS Data Store",
      "implementation": "Opensearch",
      "name": "arcgis-spatiotemporal-index-store-ask8i",
      "systemManaged": true,
      "id": "7fdc18192b084be7aed9e04d61aa9708",
      "type": "nosql"
    },
    {
      "provider": "ArcGIS Data Store",
      "implementation": "Apache Ignite",
      "name": "arcgis-cachestore-ko3db",
      "systemManaged": true,
      "id": "cce7e3d5a40d4d4d9a7cfb8ca2acae9a",
      "type": "memCacheStore"
    },
    {
      "provider": "Ozone",
      "implementation": "Ozone",
      "name": "arcgis-object-store-orae3",
      "systemManaged": true,
      "id": "9492e210-ef6b-4556-9d88-886d98ac82ee",
      "type": "objectStore"
    },
    {
      "provider": "UserManaged",
      "name": "fileShares-net-qalinux",
      "id": "35bcbf52618342b19a67028d63acb22c",
      "type": "folder"
    },
    {
      "provider": "ArcGIS Data Store",
      "implementation": "PostgreSQL",
      "name": "arcgis-relational-store-bobvl",
      "systemManaged": true,
      "id": "f327800ce3094d03b5ebbc88c709149e",
      "type": "egdb"
    },
    {
      "provider": "UserManaged",
      "name": "fileShares-qalinux.esri.com-EntConfidenceTestData-Data",
      "id": "700584f926fe4d6aa12fefaf7bddab00",
      "type": "folder"
    }
  ],
  "redacted": true,
  "siteState": "ready",
Expand