The ArcGIS Enterprise Admin API Directory, which is installed with each instance of ArcGIS Enterprise on Kubernetes, is a simple HTML interface that allows you to interact with the resources and operations exposed by the Admin API.
ArcGIS Enterprise Admin API allows you to perform administrative tasks through resource and operation endpoints. Resources are entities within your deployment that hold some information and have a well-defined state. Operations act on these resources and update their information or state. The resources and operations in the Admin API are hierarchical, with each endpoint having a unique universal resource locator (URL).
The Admin API supports token-based authentication. To use the API, you must provide a token that has been acquired from the Generate Token operation in the Portal Directory (Sharing API), or sign in to the ArcGIS Enterprise Admin API Directory HTML interface of the API as a recognized administrator, which will generate a token that will be stored during the entirety of the session.
For security reasons, all POST requests performed from ArcGIS Enterprise Admin API will need to include a token in the request body. If requests are being performed through the HTML interface of the API, the stored token—automatically generated for administrators who sign in through the HTML interface—will be added as a hidden parameter for all POST requests. For those who needed to generate a token through the Sharing API, that token must be passed as the value for the token parameter in the request.
Due to the sensitive nature of information exchanged between the Admin API and its consumer, only accessing the API over an SSL connection is supported.
The hierarchical root of the ArcGIS Enterprise Admin API beings with a well-defined URL, known as the root URL. This URL is formatted as follows:
The various resources and operations that are exposed by the API are organized hierarchically from the root URL. For example, from the root URL, administrators can manage the deployment's organizations, services, uploads, datastores, system configuration, organization logs, and jobs.
To access a resource or invoke an operation, you must do the following to create a request:
- Construct a URL to the selected resource or operation as defined in the API reference.
- Provide the relevant parameters in their specified format.
- Access the URL over the prescribed HTTPS method (either GET or POST).
Users not directly interacting with administrative or REST APIs (for example, using scripts or having a web application firewall configured) may encounter query limitations. In instances where a query string exceeds 2,048 characters in length, the query should be submitted as a POST request.
The API is stateless, which means that ArcGIS Enterprise on Kubernetes does not keep track of transactions from one request to the next. Each request must contain all the information necessary for successful processing, ensuring that each request returns a well-defined response.
There are some endpoints in ArcGIS Enterprise Admin API that, though they are present in the UI, are not currently supported. For a list of what is included with this release, see the ArcGIS Enterprise on Kubernetes help or the What's new for ArcGIS Enterprise Administrator API.