Listed below are new and updated resources, operations, parameters, and properties added to ArcGIS Enterprise Administrator API at each release.
11.2
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:
Updated operations and resources
- 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:
Deprecated operations, resources, and items
Starting at this release, administrators will no longer be able to access Grafana through the metrics viewer app. While administrators working with ArcGIS Enterprise 11.2 on Kubernetes no longer have access to Grafana through the API, Grafana can still be installed separately and used with Prometheus through the metrics API. Deployments using versions 11.1 and earlier still have access to Grafana through the metrics viewer app.
11.1
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:
New operations and resources
Updated operations and resources
- 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.
11.0
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
Note:
When a required update is available, you must apply it before upgrading to 11.0 or a subsequent release. Required updates include functional requirements and are a prerequisite to the latest software release. Review the release notes to learn about issues addressed in the latest required update.
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.
New operations and resources
The following resources and operations have been added to ArcGIS Enterprise Admin API at 11.0:
- 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 following resources and operations include updates to parameters, accepted values, or properties:
- 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.
Deprecated operations and resources
The following resources and operations have been deprecated as of this release:
- 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 Serverauthorization file.
10.9.1
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).
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.
New operations and resources
The following resources and operations have been added to ArcGIS Enterprise Admin API at 10.9.1:
- 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.
Updated operations and resources
The following resources and operations include updates to parameters, accepted values, or properties:
- 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.
Deprecated operations and resources
The following resources and operations have been deprecated as of this release:
- 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.