- URL:
- https://organization.example.com/<context>/admin
- Methods:
GET- Operations:
- Create Site
- Child Resources:
- About, Organizations, Services, Security, Uploads, Datastores, System, Logs, Overview, Mode, Usage Statistics, Jobs, Health Check, Cloud, Notebooks
- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
When you install an ArcGIS Enterprise on Kubernetes deployment for the first time, you must create a new organization site. A site is a collection of resources and operations that are used to administer and manage your organization. Once the organization site has been created, the result is the root resource for administering your deployment and a collection of hierarchically organized resources: organizations, services, uploads, datastores, system, security, logs, and jobs. Alternative views of the root page, such as json and pjson response formats, return the organization site's state and logs from its configuration. All views return the deployment version number.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the ArcGIS Enterprise Administrator API root page:
https://organization.example.com/<context>/admin?f=pjsonJSON Response example
{
"fullVersion": "10.9.1",
"resources": [
"orgs",
"logs",
"system",
"datastores",
"uploads",
"services"
],
"currentVersion": 10.9.1,
"status": {
"stages": [
{
"lastUpdated": 1619131335931,
"name": "License validation",
"state": "completed"
},
{
"lastUpdated": 1619131382110,
"name": "Configuration store",
"state": "completed"
},
{
"lastUpdated": 1619131592279,
"name": "Relational store",
"state": "completed"
},
{
"lastUpdated": 1619131517860,
"name": "Queue store",
"state": "completed"
},
{
"lastUpdated": 1619131447080,
"name": "In-memory store",
"state": "completed"
},
{
"lastUpdated": 1619131510931,
"name": "Object store",
"state": "completed"
},
{
"lastUpdated": 1619131535456,
"name": "Spatiotemporal and index store",
"state": "completed"
},
{
"lastUpdated": 1619132117498,
"name": "Portal REST API",
"state": "completed"
},
{
"lastUpdated": 1619132336315,
"name": "Services REST API",
"state": "completed"
},
{
"lastUpdated": 1619132300852,
"name": "Service lifecycle manager",
"state": "completed"
},
{
"lastUpdated": 1619131405722,
"name": "Usage statistics",
"state": "completed"
},
{
"lastUpdated": 1619132924079,
"name": "System and utility services",
"state": "completed"
},
{
"lastUpdated": 1619132203414,
"name": "Pod replicas",
"state": "completed"
}
],
"state": "ready",
"message": "The process to create a new organization has completed successfully."
},
"info": {"build": "1094"}
}