A short summary is provided below for each available endpoint in the ArcGIS Enterprise Administrator API to help you quickly identify which documentation to access depending on your workflow and needs.
Site Root
Name | Endpoint type | Description |
---|---|---|
Resource | The root organization site for the API. A site is a collection of resources and operations that are used to administer and manage your organization. | |
Operation | The configure operation is the first operation that must be invoked when ArcGIS Enterprise on Kubernetes is installed for the first time. |
Organizations
Name | Endpoint type | Description |
---|---|---|
Resource | The orgs resource lists the organizations included in an ArcGIS Enterprise on Kubernetes deployment. | |
Resource | An individual organization resources provides access to a single organization within your deployment. | |
Resource | The security resource is a collection of resource and operation endpoints that can be used to modify the security configuration for an organization. | |
Resource | The users resource houses operations used to manage members in your organization. | |
Operation | The createUser operation creates either a built-in (arcgis) user account or an enterprise user account. | |
Operation | The getEnterpriseUser operation returns the description, full name, and email address for a single user in the enterprise identity user store. | |
Operation | The searchEnterpriseUsers operation searches users in the configured enterprise user store. | |
Operation | The refreshMembership iterates over every enterprise group configured in your organization and determines whether the input user accounts belong to any of the configured enterprise groups. | |
Resource | The groups resource is a collection of operations that inventory your organization's groups. | |
Operation | The getEnterpriseGroupsForUser operation lists the groups assigned to a user account in the configured role store. | |
Operation | The getUsersWithinEnterpriseGroup operation returns a list of users who are assigned to the enterprise group within the enterprise user and group stores. | |
Operation | The serachEnterpriseGroups operation searches groups in the configured enterprise role store. | |
Operation | The refreshMembership operation iterates over every enterprise account configured in your organization and determines whether the user account is part of the input enterprise group. | |
Resource | The license resource returns high-level licensing details, such as the total number of registered members that can be added, the current number of members in the organization, and license manager information. | |
Operation | The validateLicense operation validates an input ArcGIS Enterprise on Kubernetes license file (.json). | |
Operation | The importLicense operation applies an ArcGIS Enterprise on Kubernetes license file (.json) | |
Operation | The updateLicenseManager operation updates the license server connection information for ArcGIS Enterprise on Kubernetes and registers a backup license manager for high availability. | |
Operation | The exportGeodatabaseLicense operation downloads a geodatabaseLicense.ecp file that represents the authorization file needed when enabling, creating, and updating an enterprise geodatabase in ArcGIS Pro for ArcGIS Enterprise on Kubernetes deployments. | |
Resource | The federation resource provides access to operations and resources that allow for the management of ArcGIS Server when federated with an organization. | |
Resource | The servers resource returns detailed information about your organization's federated servers. | |
Operation | The federate operation federates either a GIS Server or ArcGIS Image Server with an organization. | |
Operation | The validate operation performs validation checks against all federated GIS Server and ArcGIS Image Server types within your organization. | |
Resource | An individual server resource returns detailed information on a specific federated ArcGIS Server. | |
Operation | The validate operation performs a validation check against a federated server, returning its status and accessibility information. | |
Operation | The unfederate operation unfederates a currently federated ArcGIS Server from your organization. | |
Resource | The properties resource lists properties specific to an organization that can be modified to control your deployment. | |
Operation | The update operation updates one or more organization properties. |
Services
Name | Endpoint type | Description |
---|---|---|
Resource | The services resource acts as the root folder and container for all subfolders and GIS services for your deployment. | |
Operation | The canCreateService operation determines whether a specific service can be created successfully. | |
Operation | The createFolder operation creates a subfolder under the root Services folder. | |
Operation | The createService operation creates a GIS service in a folder by submitting a JSON representation of the service or by uploading a service definition. | |
Operation | The deleteServices operation deletes specified services from an ArcGIS Enterprise on Kubernetes organization. | |
Operation | The exists operation checks whether a folder or service exists in the organization. | |
Operation | The refreshAutodeployedServices operation automatically deploys the System or Utility services if they failed to deploy during site creation. | |
Resource | An individual service resource exposes GIS resources such as maps, rasters, locators, geodatabases through REST and SOAP interfaces. | |
Resource | The status resource provides the configured and current status of a GIS service. | |
Resource | The iteminfo resource stores a service's metadata. | |
Operation | The edit operation modifies the item information for an individual service | |
Operation | The upload operation uploads a file associated with a service's item information to the server. | |
Operation | The delete operation permanently removes a service's item information. | |
Resource | The scaling resource returns the scaling and resource allocation for a specific GIS service microservice. | |
Operation | The edit operation updates the scaling and resource allocation for an individual service. | |
Operation | The start operation starts a service and loads the service's configuration. | |
Operation | The stop operation stops all instances of a service. | |
Operation | The edit operation modifies the properties of a service. | |
Operation | The changeProvider operation updates an individual service to use either a dedicated or a shared instance type. | |
Operation | The delete operation removes an individual service, stopping the service and removing all associated resources and configurations. | |
Resource | The types resource provides metadata for all service types and extensions that can be enabled. | |
Resource | An individual type resource returns the metadata of a specific service type. | |
Resource | The extensions resource returns all the custom server object extensions (.soe file) that have been uploaded and registered with the deployment. | |
Resource | The providers resource returns the supported provider types for the GIS services in an organization. | |
Resource | The properties resource returns the default settings for newly published services. | |
Operation | The operation modifies the default settings for
newly published services. | |
Resource | The folder resource returns an individual folder's properties, including the folder's name and the services it contains. | |
Resource | The System folder resource contains automatically deployed services used by ArcGIS Server. | |
Resource | The Utilities folder contains automatically deployed GeometryServer and GPServer services that can be used by application developers. | |
Resource | The jobs resource provides access to operations that locate and monitor current asynchronous jobs being run by a geoprocessing service. | |
Operation | The query operation allows you to query jobs pertaining to a geoprocessing service. | |
Resource | An individual job resource returns information about an asynchronous job, either currently running or completed, for a geoprocessing service. |
Security
Name | Endpoint type | Description |
---|---|---|
Resource | The security resource is a collection of resource and operation endpoints that manage and configure the security for an ArcGIS Enterprise on Kubernetes deployment | |
Resource | The config resource returns the currently active security configuration for your ArcGIS Enterprise on Kubernetes deployment. | |
Operation | The update operation updates the security configuration for your ArcGIS Enterprise on Kubernetes deployment. | |
Operation | The testIdentityStore operation can be used to test the connection to a user or role (group) store. | |
Operation | The updateIdentityStore operation updates the identity provider and role (group) store configurations for ArcGIS Enterprise on Kubernetes. | |
Resource | The ingress resource returns the currently configured security information for the Ingress controller. | |
Operation | The update operation modifies the security configuration implemented by the Ingress controller. | |
Resource | The saml resource returns information about the SAML configuration for an organization. | |
Operation | The update operation enables SAML certification. | |
Resource | The certificates resource provides access to child operations and resources that can be used to manage all the security certificates configured with an organization. | |
Resource | The identity resource lists all the certificates currently configured for an organization. | |
Operation | The import operation imports an existing identity certificate in PKCS #12 format (.pfx file) into the keystore. | |
Resource | An individual certificate resource returns the details of a configured certificate for an organization. | |
Operation | The delete operation deletes an identity certificate from the key store. | |
Resource | The trust resource lists all the configured trust certificates for an organization. | |
Operation | The import operation imports a trust certificate in either a Privacy Enhanced Mail (PEM) format (.cer or .crt file) or a binary format (.der file). | |
Resource | An individual certificate resource returns the details of a configured trust certificate for an organization. | |
Operation | The delete operation removes an imported trust certificate. |
Uploads
Name | Endpoint type | Description |
---|---|---|
Resource | The uploads resource returns a list of items that have been uploaded to the deployment. | |
Operation | The upload operation uploads files to an organization. | |
Operation | The register operation directs the server to reserve space for a new item to be uploaded that is made up of one or more parts. | |
Operation | The configure resource returns the data store ID and upload path for uploaded items. | |
Resource | An individual item resource represents an item that has been uploaded to the server. | |
Operation | The commit operation completes the upload of all the parts that compose an item. | |
Operation | The uploadPart operation uploads one part of an item. | |
Operation | The download operation downloads a previously uploaded item. | |
Operation | The delete operation removes an uploaded item and its configuration. |
Datastores
Name | Endpoint type | Description |
---|---|---|
Resource | The data resource lists the system- and user-managed data stores registered with a deployment. | |
Operation | The registerItem operation registers a new data item with a data store. | |
Operation | The unregisterItem operation unregisters a data item that is registered with the server's data store. | |
Operation | The validateDataItem operation validates that the path or connection string for a specific data item is accessible to every server node in the site. | |
Resource | The config resource returns information about a data store's configuration properties that affect the behavior of the server's data holdings. | |
Operation | The findItems operation searches the various data items registered to the data store and returns a list of items found at a specified location. | |
Resource | An individual datastore resource lists the properties of both system- and user-managed data stores registered with an ArcGIS Enterprise on Kubernetes deployment. | |
Resource | The status resource returns health information for a relational data store. | |
Operation | The switchRole operation promotes a standby relational data store to the primary data store and downgrades the existing primary data store to a standby data store. | |
Resource | The config resource returns the current minimum and maximum resource allocations for a relational data store. | |
Operation | The edit operation updates the resource allocation for only the relational data store |
System
Name | Endpoint type | Description |
---|---|---|
Resource | The system resource is a collection of system-wide resources for a deployment. |
Deployments
Name | Endpoint type | Description |
---|---|---|
Resource | The deployments resource represents a list of all the microservices that are used to host or run an organization's services, as well as items that are not service related such as ArcGIS Enterprise Administrator API, portal sharing, and ingress controller microservices. | |
Resource | The properties resource returns the default template for GIS service microservices, as well as microservices that are not service related. | |
Resource | An individual microservice property template resource returns the default property template, which defines the default scaling and resource allocations for a specific microservice. | |
Operation | The edit operation modifies the default scaling and resource allocation properties for a specific microservice within your organization. | |
Resource | An individual deployment resource returns a list of properties for an individual microservice. | |
Resource | The status resource returns the current state of a microservice resource | |
Operation | The edit operation sets the scaling and resource allocation for a specific microservice. | |
Operation | The refresh operation can be used to troubleshoot microservices and pods that may be unresponsive or not functioning as expected. |
Container Registries
Name | Endpoint type | Description |
---|---|---|
Resource | The containerregistries resource returns the container registries associated with your deployment. | |
Resource | An individual container registry resource returns information for a specific container registry, including the login credentials used to access the registry | |
Operation | The edit operation allows certain container registry properties to be updated after your organization has been configured. |
Upgrades
Name | Endpoint type | Description |
---|---|---|
Resource | The upgrades resource provides access to child operations and resources that are used to manage the release and patch updates that can be applied to an ArcGIS Enterprise on Kubernetes deployment. | |
Resource | The currentVersion resource returns the current version for a deployment. | |
Resource | The history resource returns the transaction history for all upgrade and rollback operations that have been performed on an ArcGIS Enterprise on Kubernetes deployment. | |
Resource | The exports resource returns a list of request IDs for previously run updates or upgrades that encountered failures or errors during the upgrade process. | |
Operation | The export operation uploads to the deployment the curated warnings and events for a particular upgrade or update. | |
Operation | The available operation returns the version manifest, a cumulative list of release and patch versions that have been made available to an organization. | |
Operation | The upgrade operation upgrades, through either a patch or a release, an ArcGIS Enterprise on Kubernetes deployment to the current version. | |
Operation | The installed operation returns a cumulative list of patches and releases that are installed in the deployment. | |
Operation | The checkRollback operation returns a list of possible rollback options for the site, depending on the patch that is installed. | |
Operation | The rollback operation uninstalls a patch, removing the updates and fixes that had been applied to specific containers, and restoring the deployment to a previous, user-specified version of the software. | |
Operation | The importManifest operation allows organization administrators to import the version manifest into a disconnected environment that can be used to discover available updates and releases and upgrade an ArcGIS Enterprise on Kubernetes deployment. | |
Operation | The getUpgradeSettings operation returns the required upgrade settings, and their expected formats, needed for a specific release. |
Disaster Recovery
Name | Endpoint type | Description |
---|---|---|
Resource | The disasterrecovery resource allows an administrator to manage disaster recovery settings | |
Resource | The status resource returns information about the last submitted disaster recovery job. | |
Resource | The stores resource returns the backup stores that are registered with your deployment. | |
Operation | The register operation registers a backup store. | |
Resource | An individual backup store resource returns information about a specified backup store. | |
Operation | The unregister operation removes a backup store from your deployment. | |
Operation | The update operation allows you to change the properties for a backup store. | |
Operation | The validate operation ensures that the backup store is able to access the object store and is ready for backup operations to be performed. | |
Resource | The backups resource returns the backups that have been created for an organization. | |
Operation | The create operation creates a backup that can be restored in the event of data loss, data corruption, or deployment failures. | |
Resource | An individual backup resource returns information about a specific backup in a deployment. | |
Operation | The delete operation removes a specific backup from a deployment. | |
Operation | The restore operation restores the organization to the state it was in when the backup was created. | |
Operation | The update operation modifies the retentionDate set for a backup during its creation. | |
Resource | The settings resource returns the currently configured disaster recovery settings. | |
Operation | The update operation updates the disaster recovery settings for your deployment. |
Indexer
Name | Endpoint type | Description |
---|---|---|
Resource | The indexer resource contains connection information to the default indexing service. | |
Resource | The status resource allows you to view the status of the indexing service. | |
Operation | The reindex operation allows you to generate or update the indexes for content, such as users, groups, and items stored in the database store. |
System Properties
Name | Endpoint type | Description |
---|---|---|
Resource | The properties resource lists system properties that may be modified to control the ArcGIS Enterprise on Kubernetes deployment. | |
Operation | The update operation modifies the system properties for an ArcGIS Enterprise on Kubernetes deployment. |
Web Adaptors
Name | Endpoint type | Description |
---|---|---|
Resource | The webadaptors resource lists the ArcGIS Enterprise on Kubernetes Web Adaptor configured for your deployment. | |
Resource | The config resource is a collection of configuration properties that apply to the ArcGIS Enterprise on Kubernetes Web Adaptor configured with your deployment. | |
Operation | The update operation is used to change the common properties and configurations for the ArcGIS Enterprise on Kubernetes Web Adaptor configured with your deployment. | |
Resource | An individual web adaptor resource returns the properties of a specific web adaptor, such as the HTTP and HTTPS ports. | |
Operation | The unregister operation unregisters an ArcGIS Enterprise on Kubernetes Web Adaptor from your deployment. |
Licenses
Name | Endpoint type | Description |
---|---|---|
Resource | The licenses resource lists the current license level of ArcGIS Server and all authorized extensions. | |
Operation | The importServerLicenses operation imports and applies an ArcGIS Server authorization file. |
Content
Name | Endpoint type | Description |
---|---|---|
Resource | The content resource provides access to the Languages and External Content resources. | |
Resource | The languages resource returns a list of all Esri-supported languages and their associated language codes, as well as the current status of the language (either enabled or disabled). | |
Operation | The add operation enables specified languages for an organization. | |
Operation | The remove operation disables currently enabled languages for your organization. | |
Resource | The externalcontent resource returns whether access to external content has been enabled or disabled for an organization. | |
Operation | The update operation enables and disables access to Esri-provided content containing external URLs that reference sites and resources hosted outside of the organization. |
Tasks
Name | Endpoint type | Description |
---|---|---|
Resource | The tasks resource returns a list of tasks that exist within your deployment. | |
Operation | The createTask operation creates scheduled tasks for a deployment that run automatically. | |
Resource | An individual task resource returns information on a specific task, such as the task's title, parameters, and schedule. | |
Operation | The update operation allows you to edit and update the properties of a preexisting task. | |
Operation | The delete operation permanently removes a task from the deployment. | |
Operation | The enable operation enables a previously disabled task. | |
Operation | The disable operation disables a specific task and suspends any upcoming runs scheduled for the task. | |
Resource | The runs resource returns a list of all runs that have been completed for a specific task. | |
Resource | An individual run resource returns information on a task's run. | |
Operation | The update operation modifies an existing run for a scheduled task. | |
Operation | The delete operation removes a specified run for a scheduled task. |
Architecture Profiles
Name | Endpoint type | Description |
---|---|---|
Resource | The architectureprofiles resource returns the architecture profile that is set when an organization is configured. | |
Resource | The development architecture profile is used in nonproduction environments, including those for testing and evaluation, and requires the least amount of hardware and resources. | |
Resource | The standard-availability architecture profile is used in production environments and by those wanting to minimize unplanned downtime with redundancy across many pods. | |
Resource | The enhanced-availability architecture profile is used in business and mission-critical production environments. |
Logs
Name | Endpoint type | Description |
---|---|---|
Resource | The logs resource provides access to operations and resources that allow you to query and clean logs, as well as edit your deployment's log settings. | |
Operation | The query operation allows users to aggregate, filter, and page through logs for an ArcGIS Enterprise on Kubernetes deployment. | |
Operation | The search operation filters an organization's logs for specific log records using supported query types. | |
Operation | This operation deletes the log files for your deployment, freeing up disk space. | |
Operation | The export operation exports organization logs based on either query or search parameters. | |
Resource | The settings resource returns the current log settings for an organization. | |
Operation | The edit operation updates the log settings for an ArcGIS Enterprise on Kubernetes deployment. | |
Operation | The updateLogIndex operation re-creates the log indexes and can be used to troubleshoot issues related to accessing logs |
Overview
Name | Endpoint type | Description |
---|---|---|
Resource | The overview resource returns the persisted cache or real-time information, such as health or status information, for the overview resource types. | |
Resource | The config resource returns a list of resource types that correspond with the Overview page of ArcGIS Enterprise Manager. | |
Operation | The update operation can be used to modify the updateIntervalMin property for an overview resource type. |
Mode
Usage Statistics
Name | Endpoint type | Description |
---|---|---|
Resource | The usagestatistics resource provides access to the metrics viewer and metrics API tools. | |
Operation | The update/credentials operation updates the credentials for the metrics viewer and metrics API. |