Listed below are the new and updated resources and operations added to the ArcGIS Portal Administration API at each release.
As versions reach the end of their support lifecycle, their corresponding entries are removed from this document.
ArcGIS Enterprise release version
A new operation, Export Logs, has been added. This operation can be used to export and download ether standard or audit logs as .zip files.
Changes to user type licensing
At ArcGIS Enterprise 11.4, the Partner user types (lite
, basic
, and standard
) have been retired. Separate from these deprecations, the GISProfessional
user type has been merged with the creator
user type. With this merge, users assigned the creator
user type will have access to the applications previously included with the GISProfessional
.
The deprecated or removed user types cannot be used as the default user type for an organization, cannot be set as the user type assigned to new users, and cannot be assigned to the default administrator account when creating an organization. For more information about roles and user types, see User types, roles, and privileges.
Updated endpoints
- A new property,
content
, can be set using the Update Security Configuration operation. This property defines the Content-Security-Policy (CSP) response headers that are included when accessing the organization's portal website or any of its associated applications.Security Policy - The Update Token Configuration operation now generates a new base64 encoded key each time the operation is accessed. If the update is performed, the old shared key will be replaced by the generated key.
- Performing the Clean Logs operation will delete audit logs. Audit logs were introduced at 11.4. For more information, see the Export Logs operation.
At ArcGIS Enterprise 11.4, ArcGIS License Manager is no longer supported. The License resource no longer returns ArcGIS License Manager configuration information as part of its JSON response, and the Update License Manager endpoint has been deprecated.
A new endpoint, Hardware Info, can be used by administrators to monitor the disk usage space for a portal machine.
- The System Properties and Update System Properties endpoints have been updated to support a new property,
disk
. TheSpace Threshold G B disk
property specifies the threshold of usable disk space.Space Threshold G B - The Import Existing Server Certificate operations for single machine and multiple-machine environments have been updated to include the
import
parameter. TheCertificate Chain import
parameter specifies if the operation should also import the root or intermediate certificates included inside the certificate file.Certificate Chain - The Create Site operation has been updated to support a new parameter,
enable
. This parameter specifies the log level when creating a portal.Debug - Logs for requests made through the Portal Admin API have a request ID associated with them. This request ID can be used to query for logs relating to a specific request that was made.
At ArcGIS Enterprise 11.3, the GeoPlanner app has been retired. For additional details and transitioning recommendations, refer to this announcement. Licensing documentation that previously referenced GeoPlanner have had their references removed. The Get App Info documentation has been updated to include a legacy notice for GeoPlanner.
New endpoints for Language, Add Language, Remove Language, External Content, and Update External Content, have been added.
The Update Server operation can now be used to modify the administrative URL for a federated server, which is used when performing administrative operations on an internal network.
The following endpoints have been deprecated, and new endpoints have been added that take their place in previous workflows:
The new top-level resource endpoint, Info, returns the current version and build information for ArcGIS Enterprise portal.
New parameters
- The Upgrade operation now requires the
file
parameter when upgrading a portal from one release series to another (for example, upgrading from 10.9 to 11.1) or when upgrading in the same release series (for example, upgrading from 11.0 to 11.1). - A new parameter,
i
, has been added to the Upgrade operation. Thes Re Index Required i
specifies whether a full reindex is performed during the upgrade.s Re Index Required - The Export Site and Import Site operations now support the
validate
parameter. Thevalidate
parameter ensures that the folder path or file location where the exported content will be written is accessible before performing the operation.
New properties
- An
admin
property has been added to the response for the Validate Servers and Validate Server operations. TheUrl admin
property provides the administrative URL for a federated server.Url - Two new properties,
valid
andFrom Epoch valid
, have been added to the responses for both the SSL Certificate (Security) and SSL Certificate (Machines) resources. TheUntil Epoch valid
property provides the date and time information in Epoch format for the beginning of a certificate's validity. TheFrom Epoch valid
property provides the date and time information in Epoch format for the ending of a certificate's validity.Until Epoch - The Backup Restore Information resource has been updated to include a new property,
backup
, that provides date and time information, in Unix format, of the last backup of the organization when usingMode Time Stamp BACKUP
mode. - The System Properties resource has been updated to include a new property,
log
. TheBackup Warning log
property can disable backup warnings that appear in logs when the site's values forBackup Warning full
orBackup Time Stamp backup
are older than two weeks. This property can be updated using the Update System Properties operation.Mode Time Stamp
No endpoints were deprecated at this release.
The new top-level resource endpoint, Backup Restore Information, displays the backup and restore information for your organization, such as when the last full or incremental backups were performed, as well as when the last full or incremental restores were performed.
New parameters
The Upgrade operation supports two new parameters, async
and enable
. The async
operation determines whether to submit the upgrade request asynchronously or synchronously. The enable
parameter sets the log level for the upgrade process.
New properties or values
- Bulgarian has been added as a supported localization language for ArcGIS Enterprise. Bulgarian can be set as a language for your organization using the Update Languages operation, and the Languages resource now includes language information for Bulgarian.
- Both the Machines and Machine resources now return the OS platform property for each machine associated with the site.
No endpoints were deprecated at this release.
The new operation, Reconfigure Index, allows you to re-create the index service metadata, schema, and data in the event they become corrupted.
New properties
- The new Security Configuration property,
allow
, controls the value of the "Access-Control-Allow-Private-Network" response header in a CORS preflight request to a portal service URL.Internet CORSAccess - System Properties has been updated to support a new property,
enable
.W f s Service
No endpoints were deprecated at this release.
- The new resource endpoint, Database Settings, returns whether incremental backups have been enabled or disabled for your organization. If enabled, incremental backups can be disabled using the edit operation. For information about manually enabling incremental backups using the webgisdr utility, see Create an ArcGIS Enterprise backup and Configure disaster recovery for ArcGIS Enterprise.
- The new operation endpoint, Edit Database Settings, allows you to disable incremental backups for your organization if it has previously been enabled using the webgisdir utility.
New properties
- System Properties supports four new properties:
enable
,Print Service enable
,Legends Service enable
, andR s s Service enable
.K m l Service - The
security
parameter for the Update Identity Store operation supports two new properties:Config sasl
andAuthentication Scheme krb5Config
.File Path
No endpoints were deprecated at this release.
Four new endpoints, the Email Settings resource and its associated operations of Update Email Settings, Test Email Settings, and Delete Email Settings, have been added to help you manage the email settings for your organization. These email settings enable email notifications regarding password policy updates and license expirations and allow users with built-in accounts to recover forgotten passwords via email.
The Update Server operation now supports Workflow
as an ArcGIS Server function value.
No endpoints were deprecated at this release.
Read-only mode
Two new endpoints, the top-level resource Mode and its associated operation Update Mode, have been added to help organizations enable or disable read-only mode. Ready-only mode can be enabled before an upgrade to maintain availability.
Certificate management for multi-machine deployments
The Machines resource has been updated to provide access to a series of licensing operations that allow for managing certificates for associated portal machines in a multi-machine (highly available) environment. Prior to this change, certificates had to be managed on each machine individually by accessing their instance of the Portal Administrator Directory API. The new endpoints are listed below:
- SSL Certificates (HA) lists all certificates created for the Enterprise machines.
- SSL Certificate (HA) returns specific details on an SSL certificate.
- Delete Certificate (HA) deletes an SSL certificate. This operation is only accessible for highly available Enterprise portals.
- Export Certificate (HA) downloads an SSL certificate. This operation is only accessible for highly available Enterprise portals.
- Generate CSR (HA) generates a certificate signing request for a self-signed certificate. This operation is only accessible for highly available Enterprise portals.
- Generate Certificate (HA) creates a self-signed certificate. This operation is only accessible for highly available Enterprise portals.
- Import Existing Server Certificate (HA) imports an existing certificate into the key store. This operation is only accessible for highly available Enterprise portals.
- Import Root or Intermediate Certificate (HA) imports a certificate authority's root and intermediate certificates into the key store. This operation is only accessible for highly available Enterprise portals.
- Import Signed Certificate (HA) imports a certificate authority signed SSL certificate into the key store. This operation is only accessible for highly available Enterprise portals.
- Update Web Server Certificate (HA) configures properties, such as TLS protocols, used by the portal. This operation is only accessible for highly available Enterprise portals.
- All endpoints in the Portal Administrative Directory API have been updated to require specific privileges to access their functionality. Access is based on the privileges included in either a user's custom or default role, enabling Enterprise portal administrators to restrict or grant access to the resources and operations that are associated with, and required by, their assigned privileges. For a list of the privileges required for each endpoint, see the Manage Access documentation.
- The License resource has been updated to return information on user type extensions. User type extensions are licenses that extend the capabilities of ArcGIS Enterprise for specific users in an organization. They can be included in a user type or as an add-on license that you assign to members of your organization.
- The Update Security Configuration operation is no longer used to set the default user type and default user role for new members. The defaults for new members are now configured on the New Member Defaults tab in the organization settings of the Enterprise portal or through the Set User Default Settings operation in the Sharing API.
No endpoints were deprecated at this release.
No new endpoints were added at this release.
- Populate License applies the information from your license file after creating or upgrading the Enterprise portal.
- The License resource now returns detailed information regarding add-on apps and app bundles.
No endpoints were deprecated at this release.