What's new

Listed below are new and updated resources, operations, parameters, and properties added to ArcGIS Enterprise Administrator 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

ArcGIS Notebooks

Support has been added for ArcGIS Notebooks for ArcGIS Enterprise on Kubernetes. The following documentation has been added to manage the notebooks in your organization:

Notebooks: Provides a list of all ArcGIS Notebooks currently running in an organization.
Open Notebook: Moves a notebook into active status in a notebook deployment.
Update Default Template: Allows the default notebook template that is provided with ArcGIS Notebook Server to be updated and changed to a new, custom template.
Restore Default Template: Restores the default notebook template back to the original template.
Notebook: Returns the notebook's properties.
Close Notebook (Notebook): Stops a running notebook.
Deployments (Notebooks): Returns a list of Kubernetes deployment objects, and their properties, that are present in the cluster for a user.
Deployment (Notebooks): Returns information on a specific Kubernetes deployment.
Terminate Deployment: Stops a running notebook deployment.
Notebooks (Deployment): Returns a list of all notebooks currently open in a deployment object.
Notebook (Deployment Notebooks): Returns a description of the notebook's properties.
Close Notebook (Deployment Notebook): Stops a running notebook.
Runtimes: Provides a list of registered notebook runtimes.
Runtime: Returns the runtime's properties.
Update (Runtime): Updates the properties of a notebook runtime.
Manifest: Returns a JSON representation of all the Python libraries supported in the specified notebook runtime.
Create (Snapshots): Creates a point-in-time, full snapshot of a notebook.
List: Lists all snapshots associated with a notebook item.
Delete (Snapshots): Deletes one or more snapshots associated with that notebook item.
Restore (Snapshots): Restores a notebook snapshot for a notebook item.
Download (Snapshots): Downloads a notebook snapshot.
Convert to item: Converts a snapshot to a new notebook item.
Configuration (Notebooks): Provides a list of all properties that control some of a notebook's behavior.
Update (Notebooks Configuration): Updates notebook configurations.
Import (Snippets): Adds code snippets from an input file to a notebook code snippet library.
Export (Snippets): Generates a zipped file that includes a *.py file for each code snippet in a notebook code snippet library.

New endpoints

The following endpoints have been added at this release:

The Manifest Status resource, which returns whether the deployment is using an imported version manifest, and the Delete Manifest operation, which deletes an imported version manifest, have been added at this release.
The Status resource for cloud services was added at this release. This resource returns the current health of a registered cloud-native object store or relational data store.

New documentation

The following documentation has been added at this release for endpoints added during prior releases:

Find Service IDs: Queries and returns a list of the services within ArcGIS Enterprise on Kubernetes that match the filter criteria.
Get Services by ID: Returns a list of services corresponding to the IDs included in the request.
Find Deployment IDs: Queries and returns a list of IDs for microservices within ArcGIS Enterprise on Kubernetes that match the filter criteria.
Get Deployments by ID: Returns a list of microservices corresponding to the IDs included in the request.

Changes to user type licensing

At ArcGIS Enterprise 11.4, the Partner user types (liteUT, basicUT, and standardUT) have been retired. Separate from these deprecations, the GISProfessionalBasicUT user type has been merged with the creatorUT user type. With this merge, users assigned the creatorUT user type will have access to the applications previously included with the GISProfessionalBasicUT.

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, contentSecurityPolicy, 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.
The Configure operation's cloudConfig parameter has been updated to support registering cloud-native relational data stores with your deployment.
The Upgrade operation has two new parameters, volumesConfig and cloudConfig, which are used to specify the storage volume requirements and cloud service configuration and credentials for cloud-native relational object store during the upgrade process.
The Create Task operation has been updated to support scheduling health check reports.

A new operation, Release License, has been added that allows administrators to check in an organization member's license for either ArcGIS Pro or Drone2Map when the member is unable to check the license in themselves.
A new resource, Container Images, returns a list of container images that have been pulled and used to deploy applications for ArcGIS Enterprise on Kubernetes.

Volume expansion

Starting at 11.3, ArcGIS Enterprise on Kubernetes supports volume expansion for system-managed object, spatiotemporal, and relational data stores. Administrators can edit the storage values for the data store deployment's PersistentVolumeClaim, which also expands the underlying volume for that data store. The following documentation has been added for the new resources and operations added for volume expansion:

The Update (Disaster Recovery Settings) operation now supports setting theprovisioningType as STATIC for the PersistentVolumeClaim for backup and resotre operations.
Organizations can now implement device plugins to enable GPU nodes in their cluster to optimize workflows for raster analytics and deep learning. The following documentation has been updated to show the new customResources object that specifies the values requests ad limits for GPU:
The Configure operation has seen two changes for the Azure blob storage values for the cloudConfig parameter:
- Prior to 11.3, system-assigned managed identities were referred to as managed identities.
- User-assigned managed identities are now supported

New operations and resources

Webhooks returns a list of all service webhooks that are currently configured for the organization, providing a centralized location for users with the appropriate permissions to view and manage service webhooks.
Settings allows administrators to set the number of re-delivery attempts the system will make to deliver a payload to a receiver before the delivery is marked as a failure, as well as set the deactivation policy for service webhooks.
Notification Status allows administrators to set the number of re-delivery attempts the system will make to deliver a payload to a receiver before the delivery is marked as a failure, as well as set the deactivation policy for service webhooks.
Reset Standby resets the tracking mechanism used to identify a failure of the primary relational data store and forces the reconfiguration of the standby relational data store.
Update Server sets the server role and function for federated server. At this time, the only server function that can be assigned to a federated server is WorkflowManager.

Health check

Administrators can now monitor the health and stability of their organization by creating and reviewing health check reports. The following documentation has been added to this publication to serve as a reference for performing health checks, and reviewing and managing health check reports:

Node affinity and tolerations

At this release, administrators have the ability to set node affinity and tolerations for the pods of GIS services and the upgrade job, which is created whenever an upgrade or update occurs. Node affinity allows for pods to be scheduled to nodes that have matching label key-value pairs, whereas tolerations allow for pods to be scheduled on tainted nodes that would otherwise repel them if not for matching toleration and taint key-value pairs.

The following documentation has been added to this publication to serve as a reference for creating and modifying placement policies for GIS services:

The following documentation has been added to serve as a reference for creating and modifying a placement policy for the upgrade job:

Local and ephemeral volumes

Administrators can now provide volume configurations and volume configuration templates, which allow specific volumes to be attached to service pods, granting access to data or configurations needed by the service. The following documentation has been added to this publication to serve as a reference for creating persistent and ephemeral volumes:

Cloud providers and services

Support for cloud-native storage has been added at this release. Cloud storage can be configured when configuring an organization, and administrators can manage the credentials for the cloud providers and services using the Cloud APIs. The following documentation has been added to this publication to serve as a reference on managing a deployment's cloud-native storage:

Premium capabilities

ArcGIS Enterprise on Kubernetes now supports two new premium capabilities: raster analytics and image hosting. These premium capabilities can be enabled through the ArcGIS Enterprise Administrator API, so long as the organization has the appropriate licensing and meets the specific requirements for the premium capability they want to enable. The following documentation has been added to this publication to serve as a reference for enabling and disabling premium capabilities for an organization:

Service webhooks have been updated to use signature verification to ensure the integrity and security of webhook payloads sent from ArcGIS Enterprise on Kubernetes to a webhook receiver. Service webhooks can now be created or updated to use this new security measure.
The Settings (Logs) and Edit (Log Settings) endpoints have been updated to support a new log retention policy. Administrators can now define the maximum number of days logs will be retained before they are deleted.
A new parameter, cloudConfig, has been added to the Configure operation. This parameter allows administrators to set native-cloud storage for the deployment.
Support has been added for two new system properties. These new properties can be set using the Update System Properties operation:
- arcgis.com.map.url: Specifies the URL to use for the ArcGIS Online Map Viewer preview link.
- arcgis.com.map.text: Modifies the text to use for the ArcGIS Online Map Viewer preview link.
ArcGIS Enterprise on Kubernetes now supports version 2 (v2) of autoscaling. Prior to 11.2, autoscaling could be configured using the beta version of v2 autoscaling (v2beta2). Organizations using ArcGIS Enterprise 10.9.1 on Kubernetes have access to version 1 (v1) of autoscaling. The following documentation has been updated to highlight the changes in autoscaling version support:

New operations and resources

Exports—This resource returns a list of previously run upgrades or updates that encountered errors during the upgrade process.
Export—This operation exports upgrade data, uploaded to the deployment as a .zip file, that can be downloaded and used to troubleshoot post-upgrade.

Service webhooks

Support for feature service and geoprocessing service webhooks has been added to the ArcGIS Enterprise Administrator API. Feature service webhooks allow administrators to subscribe to event triggers pertaining to a feature service in their organization. Though geoprocessing services do not have specific event triggers that administrators can subscribe to, geoprocessing service webhooks will be invoked when a geoprocessing service job is completed. The following documentation has been added to this publication to serve as references for the service webhook endpoints:

Get Upgrade Settings—The volumesConfig response property has been deprecated at this release.
Upgrade—The licenseFile parameter, which was deprecated at 11.0, has been reintroduced with this release. Administrators can choose to pass licensing information either through the licenseFile parameter or through the upgradeSettings parameter.

Export Geodatabase License—This operation downloads a geodatabaseLicense.ecp file that represents the authorization file needed when enabling, creating, and updating an enterprise geodatabase in ArcGIS Pro.
Export Logs—This operation exports organization logs based on either query or search parameters.
External Content—This resource returns whether access to external content has been enabled or disabled for an organization.
Update (External Content)—This operation enables and disables access to Esri-provided content containing external URLs that reference sites and resources hosted outside of the organization.

Updated operations and resources

The Create Service operation now supports version 2 of the autoscaling feature. The newest version of autoscaling allows for the min, max, scalingMode, and averageUtilization values to be passed through during a service's creation.
The Languages resource, as well as the Add and Remove child operations, now support Bulgarian (Български) as an Esri-supported language.
A new parameter, options, was added to both the Register Item and Validate Data Item operations. The parameter supports a JSON array of additional properties used during data item registration and validation. Currently, this parameter only supports the allowServicesRestart property. By setting allowServicesRestart to true, administrators are acknowledging that registering a new file share location will disrupt their organization. Not providing allowServicesRestart, or setting it to false, will cause the registration of the new file share location to fail.
The Register, Register Item, and Validate Data Item operations now support asynchronous jobs. If run asynchronously, a job is created for the request, which can be checked occasionally to monitor progress and view status messages.

Autoscaling in ArcGIS Enterprise on Kubernetes

Introduced at ArcGIS Enterprise on Kubernetes 10.9.1 with version 1 of the autoscaling feature, 11.0 introduces version 2 of autoscaling in ArcGIS Enterprise on Kubernetes. Autoscaling allows administrators to configure and deploy systems that respond to unexpected performance demands with minimal intervention and overhead. The ArcGIS Enterprise on Kubernetes autoscaling capability uses horizontal pod autoscaling, which, in response to an increase in resource usage, deploys additional pods according to the values set by the administrator.

The following resources and operations have been updated to return information on, or enable, autoscaling and should be referenced for more information on the properties and values needed to enabled autoscaling:

Licensing updates

Licensing has been consolidated to a single license file at ArcGIS Enterprise on Kubernetes 11.0. The ArcGIS Enterprise on Kubernetes license file contains the ArcGIS Enterprise portal user types and add-on licenses and capabilities needed for a deployment. Management for the ArcGIS Enterprise on Kubernetes license file is provided by the organization-level license resource and child operations. The system-level licenses resource and importServerLicenses operation have been deprecated.

Upgrade changes for ArcGIS Enterprise on Kubernetes

Starting with this release, before performing an upgrade, you must retrieve the required upgrade settings that will be passed through as part of the upgrade operation. Some settings require user input before they can be used during an upgrade. Currently, the object supports the following three upgrade settings: updateToLatestPatch, licenseUpload, and volumesConfig.

Licenses—The licenses previously listed the license level of ArcGIS Server and all authorized extensions.
Import Server Licenses—The importServerLicenses operation previously imported and applied an ArcGIS Server authorization file.

New operations and resources

Update (Organization Properties)—This operation updates one or more organization properties.
Properties (Organization)—This resource lists properties specific to an organization that can be modified to control your deployment.
Configuration (Data Store)—This resource returns the current minimum and maximum resource allocations for a relational data store.
Edit (Data Store Configuration)—This operation updates the resource allocation for a relational data store.
Container Registry—This resource returns information for a specific container registry, including the registry login credentials.
Container Registries—This resource returns the container registries associated with your deployment.
Edit (Container Registry)—The operation allows for certain container registry properties to be updated after your organization has been configured.
Update (Backup)—This operation updates the set retention date for a backup.
Update (Backup Store)—This operation updates the properties for a backup store. Currently, this is limited to setting the backup store as the default store for your deployment.
Validate (Backup Store)—This operation validates that the backup store is able to access the object store and that the backup store is ready to perform backup operations.
Create (Task)—This operation creates a schedule of tasks for your deployment that run automatically. Currently, only CreateBackup tasks can be created.
Search—This operation allows you to filter your organization's log for specific log records using supported query types.
Job—This resource returns the progress and status message of an asynchronous job.
Jobs—This resource is a collection of jobs created within your deployment.

Web adaptors

Web adaptor functionality was deferred from the initial release of 10.9. At 10.9.1, web adaptor functionality, and the operations and resources in ArcGIS Enterprise Admin API associated with those functions, are supported.

Updated operations and resources

A new parameter, userManagedStores, has been added to the Configure operation. This parameter supports registering root folder paths for data stores using Network File Sharing. It's recommended that folder paths are registered using the userManagedStores parameter, rather than folderPathsToRegister.
Both the Configuration (Security) and Update (Security Configuration) operations support a new property, allowInternetCORSAccess. The allowInternetCORSAccess property controls the value of the "Access-Control-Allow-Private-Network" response header in a CORS preflight request.
A new parameter, retentionDate, has been added to the Create (Backup) operation. The retention date is the day when the backup will become eligible for cleanup by the backupRetentionCleaner task.
The Update (Task) operation supports updating any scheduled CreateBackup and BackupRetentionCleaner tasks. This includes support for updating the passcode for a backup.
The function of the startTime and endTime parameters for Query has been changed at 10.9.1. At 10.9, startTime specified the oldest time to query logs against, whereas endTime specified the most recent time to query logs against. At 10.9.1, startTime and endTime mirror their ArcGIS Enterprise counterparts, with startTime specifying the most recent time to query logs against and endTime specifying the oldest time to query against.

Asynchronous operations

At 10.9.1, certain operations in ArcGIS Enterprise Admin API support running asynchronously. If run asynchronously, a job is created for the request, which can be checked occasionally to monitor progress and view status messages.

The following operations support the async operation:

Register data store item

With ArcGIS Enterprise on Kubernetes 10.9.1, it's recommended that root folder paths being registered for data stores use Network File Sharing (NFS). These folder paths can be registered during organization configuration using the userManagedStores parameter. Though it's no longer recommended, support for folderPathsToRegister, which was the parameter used at 10.9 to register root folder paths during organization configuration, has not been removed. For more information, see Register Item (Data Stores).

Find Services—The findServices operation could query and return a list of the services within your deployment.
Find Deployments—The findDeployments operation could query and return a list of microservices within your deployment.
Backup and Restore—The backuprestore resource provided access to the backups created for your organization, as well as operations to create a backup and check the status of a current backup. The child resources and operations previously housed under backuprestore have been moved elsewhere within the Disaster Recovery section of API. For an updated site structure, see Resource hierarchy.