About | ArcGIS REST APIs | Esri Developer

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

Access requirements

Required privileges

The Sever 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.

Register data stores Feature layer Update Delete Security and infrastructure Servers Organization webhooks Geoprocessing Publisher role

Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 Server Administrator API must include a token in the request body.

Learn how to generate a token

Description

The about resource returns hardware, extension, and license information for an ArcGIS Server. Starting at ArcGIS Enterprise 12.0, this resource also includes information on patches that have been installed on the server, including the install date and patch name.

Request parameters

Parameter Details

Parameter	Details
`redact` (Optional)	Introduced at ArcGIS Enterprise 12.0. 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)

Introduced at ArcGIS Enterprise 12.0. 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 without redacted values:

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

JSON Response example

Use dark colors for code blocksCopy
{
  "lastUpdated": 1741804531694,
  "serverId": "JPIqLG1SUINAQ2NH",
  "siteUrl": "https://servermachine.example.com/server",
  "webContextUrl": "",
  "isHosted": false,
  "serverType": "ArcGIS",
  "serverRole": "HOSTING_SERVER",
  "serverFunction": "KnowledgeServer,RasterAnalytics,ImageHosting,WorkflowManager",
  "currentBuild": "56632",
  "currentVersion": "11.5.0",
  "machines": [
    {
      "machineName": "SERVERMACHINE.EXAMPLE.COM",
      "adminURL": "https://servermachine.example.com:6443/arcgis/admin",
      "webServerCertificateAlias": "wildcard_esri_com_202503120546",
      "licenses": {
        "edition": {
          "name": "svradvanced",
          "version": "11.5",
          "canExpire": true,
          "expiration": 1792566000000,
          "featureName": "esriServerLicenseAdvanced"
        },
        "level": {
Expand