A short summary is provided below for each available endpoint in the ArcGIS Server Administrator Directory API to help you quickly identify which documentation to access depending on your workflow and needs.
Site root
Name | Endpoint type | Description |
---|---|---|
Resource | The site root is a collection of server resources, including server machines that are installed with ArcGIS Server, GIS services, data, and so on. | |
Operation | The createNewSite operation is the first operation that you must invoke when you install ArcGIS Server for the first time. | |
Operation | The deleteSite operation deletes the site configuration and releases all server resources. | |
Operation | The exportSite operation exports the site configuration to a location you specify as input for this operation. | |
Operation | The generateToken operation generates a security token that can be used by clients when working with the Administrator API. | |
Operation | The importSite operation imports a site configuration into the currently running site. | |
Operation | The joinSite operation connects a server machine to an existing site. | |
Resource | The publicKey resource returns the public key of the server that can be used by a client application (or script) to encrypt data sent to the server using the RSA algorithm for public-key encryption. | |
Operation | The upgrade operation upgrades your deployment of ArcGIS Server. |
Machines
Name | Endpoint type | Description |
---|---|---|
Resource | The machines resource represents a collection of all the server machines that have been registered with the site. | |
Operation | The register operation registers a server machine with the site. The server machine must have ArcGIS Server software installed and authorized. | |
Operation | The rename operation changes the machine name and updates any references to a machine in your ArcGIS Server site. | |
Resource | The machine resource represents a server machine on which ArcGIS Server software has been installed and licensed. | |
Operation | The edit operation allows you to make changes to the configuration of the specified machine in your ArcGIS Server site. | |
Operation | The start operation starts the server machine if it's participating in a site. | |
Operation | The stop operation stops the application server running on the specific server machine. | |
Operation | The synchronizeWithSite operation allows administrators to manually synchronize specific machines with the site. | |
Operation | The unregister operation deletes the server machine from the site. | |
Resource | The hardware resource displays hardware information for the specified machine in your ArcGIS Server site. | |
Resource | The sslcertificates resource lists all the certificates (self-signed and CA-signed) created for the server machine. | |
Operation | The generate operation creates a self-signed certificate, or it can be used as a starting point for getting a production-ready CA-signed certificate. | |
Operation | The importExistingServerCertificate operation imports an existing server certificate, stored in the PKCS #12 format, into the keystore. | |
Operation | The importRootOrIntermediate operation imports a CA root and intermediate certificates into the keystore. | |
Resource | The certificate resource provides information on an individual certificate. | |
Operation | The export operation downloads an SSL certificate. | |
Operation | The delete operation deletes an SSL certificate from the key store. | |
Operation | The generateCSR operation generates a certificate signing request (CSR) for a self-signed certificate. | |
Operation | The importSignedCertificate operation imports a CA-signed SSL certificate into the keystore. |
Services
Name | Endpoint type | Description |
---|---|---|
Resource | The services resource is the root folder for all subfolders and GIS services. | |
Operation | The canCreateService operation can be used to determine whether a specific service can be created on the ArcGIS Server site. | |
Operation | The createFolder operation creates a subfolder underneath the root folder. | |
Operation | The createService operation creates a new GIS service in a folder. | |
Operation | The deleteServices operation deletes the desired services on all reachable server machines. | |
Operation | The editFolder operation allows you to change the description of an existing folder or change the web-encrypted property. | |
Operation | The exists operation checks whether a folder or service exists on the GIS server. | |
Operation | The exportServices operation exports the existing site's services to a location you specify as input to this operation. | |
Operation | The federate operation is used when federating ArcGIS Server with Portal for ArcGIS. | |
Operation | The importServices operation imports the site services from a provided .agssiteservices file previously generated by the export services operation. | |
Operation | The renameService operation can be used to change the name of a published GIS service in a particular folder. | |
Operation | The startServices operation starts the desired services on all (reachable) server machines in the site. | |
Operation | The stopServices operation stops the desired services on all reachable server machines in the site. | |
Operation | The unfederate operation is used when unfederating ArcGIS Server with your ArcGIS Enterprise portal. | |
Resource | The folder resource returns an individual folder's properties, including its description and the services it contains. | |
Operation | The deleteFolder operation deletes a folder and all services in it. | |
Operation | The editFolder operation allows you to change the description of an existing folder or change the web-encrypted property. | |
Operation | The renameService operation can be used to change the name of a published GIS service in a particular folder. | |
Resource | The permissions resource models the permissions on the specified folder or service. | |
Operation | The add operation assigns a new permission to a role (principal). | |
Operation | The clean operation cleans all permissions that have been assigned to a role (principal). | |
Operation | The hasChildPermissionsConflict operation determines whether this resource (either a folder or service) has a child resource with opposing permissions. | |
Resource | The properties resource provides the default settings for new services when they are published to ArcGIS Server. | |
Operation | The update operation updates the default settings for properties that govern new services published to ArcGIS Server. | |
Resource | The service resource exposes GIS resources such as maps, rasters, locators, geodatabases, and so forth through REST and SOAP interfaces. | |
Operation | The delete operation deletes a service. | |
Operation | The edit operation edits a service by editing the JSON representation of the service. | |
Operation | The start operation starts the service. | |
Operation | The stop operation stops all instances of the service on all reachable server machines in the site. | |
Resource | The statistics resource provides a view into the life cycle of all instances of the service on all server machines in the site. | |
Resource | The iteminfo resource stores metadata about a service. | |
Operation | The delete operation deletes an item's information. | |
Operation | The edit operation edits the item information and must be a multipart POST request with an optional image uploaded to the server (defined by the thumbnail parameter). | |
Resource | A service's lifecycleinfos resource returns the date and time information for when a service was created or updated. | |
Operation | The upload operation uploads a file associated with the item information to the server. | |
Resource | The report resource provides a configurable summary of all the services in a folder. | |
Resource | The types resource provides metadata about all service types and extensions that can be enabled on each service type. | |
Resource | The extensions resource is a collection of all the custom server object extensions that have been uploaded and registered with the server. | |
Operation | The register operation registers a new server object extension file (.soe) with the server. | |
Operation | The unregister operation unregisters all the extensions from a previously registered server object extension file (.soe). | |
Operation | The update operation updates extensions that have been previously registered with the server. | |
Resource | The providers resource returns the supported provider types for the GIS services in your organization. |
Security
Name | Endpoint type | Description |
---|---|---|
Resource | The security resource is a container for all resources and operations that manage security for your site. | |
Resource | The psa resource provides access to operations that allow you to configure the credentials and the login privileges of the primary site administrator account. | |
Operation | The disable operation disables login privileges for the primary site administrator account. | |
Operation | The enable operation enables login privileges for the primary site administrator account. | |
Operation | The update operation changes the account properties of the primary site administrator. | |
Resource | The roles resource represents all roles available in the role store. | |
Operation | The add operation adds a role to the role store. | |
Operation | The addUsersToRole operation assigns a role to multiple users. | |
Operation | The assignPrivilege operation assigns a privilege to a role. | |
Operation | The getPrivilege operation returns the privilege associated with a role. | |
Operation | The getRoles operation gives you a pageable view of roles in the role store. | |
Operation | The getRolesByPrivilege operation returns the roles associated with a privilege. | |
Operation | The getRolesForUser operation returns a list of role names that have been assigned to a particular user account. | |
Operation | The getUsersWithinRole operation searches user accounts to see to whom a specific role has been assigned. | |
Operation | The remove operation removes an existing role from the role store. | |
Operation | The removeUsersFromRole operation removes a role assignment from multiple users. | |
Operation | The search operation searches a specific role or a group of roles from the role store. | |
Operation | The update operation updates a role in the role store with new information. | |
Resource | The config resource returns the currently active security configuration. | |
Operation | The testIdentityStore operation tests the connection to the input user and role store. | |
Operation | The updateIdentityStore operation updates the location and properties for the user and role store in your ArcGIS Server site. | |
Operation | The update operation updates the security configuration, including TLS protocols and cipher suites, for your ArcGIS Server site. | |
Resource | The tokens resource represents the token configuration associated with the server. | |
Operation | The update operation changes the token manager configuration. | |
Resource | The users resource represents all users available in the user store that can administer ArcGIS Server and access the GIS services hosted on the server. | |
Operation | The add operation adds a user account to the user store. | |
Operation | The assignRoles operation assigns roles to a user account when working with a user and role store that support read and write privileges. | |
Operation | The getPrivilege operation returns the privilege associated with a user. | |
Operation | The getUsers operation gives you a pageable view of users in the user store. | |
Operation | The remove operation removes an existing user account from the user store. | |
Operation | The removeRoles operation removes roles that have been previously assigned to a user account. | |
Operation | The search operation searches a specific user or a group of users from the user store. | |
Operation | The update operation updates a user account in the user store with new information. |
System
Name | Endpoint type | Description |
---|---|---|
Resource | The system resource is a collection of miscellaneous server-wide resources. | |
Resource | The deployment resource returns information about the current deployment configuration. Legacy:Sites with multiple clusters have been deprecated. | |
Resource | The configstore resource maintains all of the server's configurations. | |
Operation | The edit operation updates the configuration store. | |
Operation | The recover operation copies the configuration store from the local repository to the shared configuration store location. | |
Resource | The directories resource lists all the server directories. | |
Operation | The register operation registers a new server directory. | |
Operation | The recover operation copies the server directories from the local repository into the shared server directories location. | |
Resource | The server directory resource returns the properties of an individual directory. | |
Operation | The clean operation cleans the content (files and folders) in the directory that has passed its expiration date. | |
Operation | The edit operation allows you to change the directory's path as well as its cleanup properties. | |
Operation | The unregister operation unregisters a server directory. | |
Resource | A handlers resource exposes the GIS capabilities of ArcGIS Server through a REST and SOAP interface or API. | |
Resource | The rest resource provides access to operations that allow you to clear the in-memory cache built by the REST handler or enable and disable the HTML browsing capabilities of the handler. | |
Resource | The cache operation clears the REST cache. | |
Operation | The clear operation clears the cache on all REST handlers in the system. | |
Resource | The servicesdirectory resource lists properties of the ArcGIS REST API (also known as the Services Directory). | |
Operation | The edit operation enables or disables the HTML view of the ArcGIS REST API (also known as the Services Directory). | |
Resource | The soap resource provides access to the soaphandlersconfig resource endpoint. | |
Resource | The soaphandlerconfig resource lists the URLs for domains allowed to make cross-domain requests. | |
Operation | The edit operation allows you to restrict cross-domain requests. | |
Resource | The jobs resource is a collection of all the administrative jobs (asynchronous operations) created in your site. | |
Resource | The job resource represents the asynchronous execution of an operation. | |
Resource | The licenses resource lists the current license level of ArcGIS Server and all authorized extensions. | |
Resource | The platformservices resource allows you to view and manage your platform services in the ArcGIS Server Administrator Directory. | |
Resource | The Compute Platform resource allows you to view and manage your compute platform service for ArcGIS GeoAnalytics Server in the ArcGIS Server Administrator Directory. | |
Operation | The health operation returns information for each machine that participates in the Compute Platform service and details the workers. | |
Operation | The start operation allows you to run your Compute Platform service in the ArcGIS Server Administrator Directory. | |
Operation | The status resource allows you to view the status of the Compute Platform service. | |
Operation | The stop operation allows you to stop your Compute Platform service in the ArcGIS Server Administrator Directory. | |
Resource | The Message Bus resource allows you to view and manage your Message Bus service in the ArcGIS Server Administrator Directory. | |
Operation | The health operation returns information for each machine that participates in the Message Bus service. | |
Operation | The start operation allows you to run your Message Bus service in the ArcGIS Server Administrator Directory. | |
Operation | The stop operation allows you to stop your Message Bus service in the ArcGIS Server Administrator Directory. | |
Operation | The status resource allows you to view the status of the Message Bus service. | |
Resource | The Synchronization service resource allows you to view and manage the Synchronization service for ArcGIS GeoAnalytics Server in the ArcGIS Server Administrator Directory. | |
Operation | The health operation returns information for each machine that participates in the Synchronization service. | |
Operation | The reset operation resets the synchronization service and restarts both the Synchronization and Compute Platform services. | |
Operation | The start operation allows you to run your Synchronization service in the ArcGIS Server Administrator Directory. | |
Operation | The stop operation allows you to stop your synchronization service in the ArcGIS Server Administrator Directory. | |
Operation | The status resource allows you to view the status of the Synchronization service. | |
Resource | The properties resource is a container for configuration properties that govern the behavior of ArcGIS Server. | |
Operation | The update operation allows you to update the server properties. | |
Resource | The webadaptors resource lists all the web adaptors that have been registered with the site. | |
Resource | The config resource lists all the configuration parameters shared across all the Web Adaptors in the site. | |
Operation | The update operation changes the configuration parameters and shared key. | |
Resource | The webadaptor resource returns the properties of an individual Web Adaptor, such as the HTTP and HTTPS ports and description. | |
Operation | The unregister operation unregisters a Web Adaptor, which removes it from the server's trusted list. | |
Operation | The update operation allows you to update the description, HTTP port, and HTTPS port of a Web Adaptor that is registered with the server. |
Data
Name | Endpoint type | Description |
---|---|---|
Resource | The data resource provides information about the data holdings of the server. | |
Operation | The computeTotalRefCount operation computes the total number of references to a given data item that exist on the server. | |
Operation | The federateDataItem operation creates a data store item in the portal for a data store that has been registered with one of the portal's federated ArcGIS Server sites. | |
Operation | The findItems operation searches through the various data items registered in the server's data store and returns a list of items found at a specified location. | |
Operation | The registerItem operation registers a new data item with the server's data store. | |
Operation | The unregisterItem operation unregisters a data item that has been previously registered with the server's data store. | |
Operation | The validateAllDataItems operation can be used to validate that the path (for file shares) or connection strings (for databases) for all registered data items are accessible to every server node in the site. | |
Operation | The validateDataItem operation validates that the path (for file shares) or connection string (for databases) for a specific data item is accessible to every server node in the site by checking against the JSON representing the data item. | |
Resource | The manifest resource returns the manifest resource for a big data file share. | |
Operation | The regenerate operation regenerates the manifest for a big data file share. | |
Operation | The update operation uploads a manifest for a big data file share item that will replace the existing manifest for the big data file share item. | |
Resource | The hints resource returns the hints for a big data file share. | |
Operation | The update operation uploads a hints file for a big data file share item, which will replace the existing hints file. | |
Resource | The config resource returns information on the data store's configuration properties. | |
Operation | The update operation allows you to update the data store configuration. | |
Resource | The items resource lists the root data items in the data store. | |
Resource | A data store item's lifecycleinfos resource returns the date and time information (in Unix epoch format) for when a data store item was created and updated. | |
Operation | The edit operation edits the connection information for an existing data item. | |
Operation | The makePrimary operation promotes a standby machine to the primary Data Store machine while also downgrading the existing primary machine to act as a standby machine. | |
Operation | The remove operation removes a standby machine from the Data Store. | |
Operation | The start operation starts the database instance running on a Data Store machine. | |
Operation | The stop operation stops the database instance running on a Data Store machine. | |
Operation | The validate operation checks the status of ArcGIS Data Store and provides a health check response. |
Uploads
Name | Endpoint type | Description |
---|---|---|
Resource | The uploads resource is a collection of all the items that have been uploaded to the server. | |
Operation | The register operation directs the server to reserve space for a new item (to be uploaded) that could be composed of one or more parts. | |
Operation | The upload operation uploads a new item to the server. Once the operation is completed successfully, the JSON structure of the uploaded item is returned. | |
Resource | The item resource represents an item that has been uploaded to the server. | |
Operation | The commit operation completes the upload of all the parts that make an item. | |
Operation | The delete operation deletes the uploaded item and its configuration. | |
Operation | The uploadPart operation uploads one part of an item. | |
Operation | The parts resource lists all the parts associated with an item that have been uploaded to the server. |
Logs
Name | Endpoint type | Description |
---|---|---|
Resource | The logs resource provides access to operations and resources associated with the server logs. | |
Operation | The clean operation forces the server to clean the logs, freeing up disk space. | |
Operation | The countErrorReports operation counts the number of error (crash) reports that have been generated on each machine. | |
Operation | The query operation provides a way to aggregate, filter, and page through logs across the entire ArcGIS Server site. | |
Resource | The settings resource returns the current log settings. | |
Operation | The edit operation updates the log settings for the entire server site. |
KML
Name | Endpoint type | Description |
---|---|---|
Resource | The kml resource is a container for all the .kmz files created on the server. | |
Operation | The createKmz operation creates a .kmz file from the input .kml file uploaded to the server. | |
Resource | The kmz resource returns the .kmz file created from the input .kml file. |
Info
Name | Endpoint type | Description |
---|---|---|
Resource | The info resource returns meta information about the server. |
Mode
Name | Endpoint type | Description |
---|---|---|
Resource | The mode resource returns the current mode of the site. | |
Operation | The update operation is used to move between the two types of site modes. |
Usage Reports
Name | Endpoint type | Description |
---|---|---|
Resource | The usagereports resource returns the parameters of a usage report. | |
Operation | The add operation creates a usage report. | |
Resource | The settings resource returns the current usage report settings. | |
Operation | The edit operation updates the usage report settings. | |
Resource | The usagereport resource returns the parameters of a usage report. | |
Operation | The edit operation updates the usage report. | |
Operation | The data operation retrieves server usage data for the report. | |
Operation | The delete operation deletes the usage report. |