Endpoint summaries

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

NameEndpoint typeDescription

Site root

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.

Create Site

Operation

The createNewSite operation is the first operation that you must invoke when you install ArcGIS Server for the first time.

Delete Site

Operation

The deleteSite operation deletes the site configuration and releases all server resources.

Export Site

Operation

The exportSite operation exports the site configuration to a location you specify as input for this operation.

Generate Token

Operation

The generateToken operation generates a security token that can be used by clients when working with the Administrator API.

Import Site

Operation

The importSite operation imports a site configuration into the currently running site.

Join Site

Operation

The joinSite operation connects a server machine to an existing site.

Public Key

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.

Upgrade

Operation

The upgrade operation upgrades your deployment of ArcGIS Server.

Machines

NameEndpoint typeDescription

Machines

Resource

The machines resource represents a collection of all the server machines that have been registered with the site.

Register Machine

Operation

The register operation registers a server machine with the site. The server machine must have ArcGIS Server software installed and authorized.

Rename Machine

Operation

The rename operation changes the machine name and updates any references to a machine in your ArcGIS Server site.

Machine

Resource

The machine resource represents a server machine on which ArcGIS Server software has been installed and licensed.

Edit Machine

Operation

The edit operation allows you to make changes to the configuration of the specified machine in your ArcGIS Server site.

Start Machine

Operation

The start operation starts the server machine if it's participating in a site.

Stop Machine

Operation

The stop operation stops the application server running on the specific server machine.

Synchronize With Site

Operation

The synchronizeWithSite operation allows administrators to manually synchronize specific machines with the site.

Unregister Machine

Operation

The unregister operation deletes the server machine from the site.

Hardware Configuration

Resource

The hardware resource displays hardware information for the specified machine in your ArcGIS Server site.

SSL Certificates

Resource

The sslcertificates resource lists all the certificates (self-signed and CA-signed) created for the server machine.

Generate Certificate

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.

Import Existing Server Certificate

Operation

The importExistingServerCertificate operation imports an existing server certificate, stored in the PKCS #12 format, into the keystore.

Import Root Certificate

Operation

The importRootOrIntermediate operation imports a CA root and intermediate certificates into the keystore.

SSL Certificate

Resource

The certificate resource provides information on an individual certificate.

Export Certificate

Operation

The export operation downloads an SSL certificate.

Delete Certificate

Operation

The delete operation deletes an SSL certificate from the key store.

Generate CSR

Operation

The generateCSR operation generates a certificate signing request (CSR) for a self-signed certificate.

Import CA Signed Certificate

Operation

The importSignedCertificate operation imports a CA-signed SSL certificate into the keystore.

Services

NameEndpoint typeDescription

Services

Resource

The services resource is the root folder for all subfolders and GIS services.

Can Create Service

Operation

The canCreateService operation can be used to determine whether a specific service can be created on the ArcGIS Server site.

Create Folder

Operation

The createFolder operation creates a subfolder underneath the root folder.

Create Service

Operation

The createService operation creates a new GIS service in a folder.

Delete Services

Operation

The deleteServices operation deletes the desired services on all reachable server machines.

Edit Folder

Operation

The editFolder operation allows you to change the description of an existing folder or change the web-encrypted property.

Exists

Operation

The exists operation checks whether a folder or service exists on the GIS server.

Export Services

Operation

The exportServices operation exports the existing site's services to a location you specify as input to this operation.

Federate

Operation

The federate operation is used when federating ArcGIS Server with Portal for ArcGIS.

Import Services

Operation

The importServices operation imports the site services from a provided .agssiteservices file previously generated by the export services operation.

Rename Service

Operation

The renameService operation can be used to change the name of a published GIS service in a particular folder.

Start Services

Operation

The startServices operation starts the desired services on all (reachable) server machines in the site.

Stop Services

Operation

The stopServices operation stops the desired services on all reachable server machines in the site.

Unfederate

Operation

The unfederate operation is used when unfederating ArcGIS Server with your ArcGIS Enterprise portal.

Folder

Resource

The folder resource returns an individual folder's properties, including its description and the services it contains.

Delete Folder

Operation

The deleteFolder operation deletes a folder and all services in it.

Edit Folder

Operation

The editFolder operation allows you to change the description of an existing folder or change the web-encrypted property.

Rename Service

Operation

The renameService operation can be used to change the name of a published GIS service in a particular folder.

Permissions

Resource

The permissions resource models the permissions on the specified folder or service.

Add Permission

Operation

The add operation assigns a new permission to a role (principal).

Clean Permissions

Operation

The clean operation cleans all permissions that have been assigned to a role (principal).

Has Child Permissions Conflict

Operation

The hasChildPermissionsConflict operation determines whether this resource (either a folder or service) has a child resource with opposing permissions.

Default Service Properties

Resource

The properties resource provides the default settings for new services when they are published to ArcGIS Server.

Update Default Service Properties

Operation

The update operation updates the default settings for properties that govern new services published to ArcGIS Server.

Service

Resource

The service resource exposes GIS resources such as maps, rasters, locators, geodatabases, and so forth through REST and SOAP interfaces.

Delete Service

Operation

The delete operation deletes a service.

Edit Service

Operation

The edit operation edits a service by editing the JSON representation of the service.

Start Service

Operation

The start operation starts the service.

Stop Service

Operation

The stop operation stops all instances of the service on all reachable server machines in the site.

Service Statistics

Resource

The statistics resource provides a view into the life cycle of all instances of the service on all server machines in the site.

Item Information

Resource

The iteminfo resource stores metadata about a service.

Delete Item Information

Operation

The delete operation deletes an item's information.

Edit Item 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).

Lifecycle Information

Resource

A service's lifecycleinfos resource returns the date and time information for when a service was created or updated.

Upload Item Information File

Operation

The upload operation uploads a file associated with the item information to the server.

Service Report

Resource

The report resource provides a configurable summary of all the services in a folder.

Types

Resource

The types resource provides metadata about all service types and extensions that can be enabled on each service type.

Extensions

Resource

The extensions resource is a collection of all the custom server object extensions that have been uploaded and registered with the server.

Register Extension

Operation

The register operation registers a new server object extension file (.soe ) with the server.

Unregister Extension

Operation

The unregister operation unregisters all the extensions from a previously registered server object extension file (.soe ).

Update Extension

Operation

The update operation updates extensions that have been previously registered with the server.

Providers

Resource

The providers resource returns the supported provider types for the GIS services in your organization.

Security

NameEndpoint typeDescription

Security

Resource

The security resource is a container for all resources and operations that manage security for your site.

Primary Site Administrator

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.

Disable Primary Site Administrator

Operation

The disable operation disables login privileges for the primary site administrator account.

Enable Primary Site Administrator

Operation

The enable operation enables login privileges for the primary site administrator account.

Update Primary Site Administrator

Operation

The update operation changes the account properties of the primary site administrator.

Roles

Resource

The roles resource represents all roles available in the role store.

Add Role

Operation

The add operation adds a role to the role store.

Add Users to Role

Operation

The addUsersToRole operation assigns a role to multiple users.

Assign Privilege

Operation

The assignPrivilege operation assigns a privilege to a role.

Get Privilege for Role

Operation

The getPrivilege operation returns the privilege associated with a role.

Get Roles

Operation

The getRoles operation gives you a pageable view of roles in the role store.

Get Roles by Privilege

Operation

The getRolesByPrivilege operation returns the roles associated with a privilege.

Get Roles for User

Operation

The getRolesForUser operation returns a list of role names that have been assigned to a particular user account.

Get Users Within Role

Operation

The getUsersWithinRole operation searches user accounts to see to whom a specific role has been assigned.

Remove Role

Operation

The remove operation removes an existing role from the role store.

Remove Users from Role

Operation

The removeUsersFromRole operation removes a role assignment from multiple users.

Search Roles

Operation

The search operation searches a specific role or a group of roles from the role store.

Update Role

Operation

The update operation updates a role in the role store with new information.

Security Configuration

Resource

The config resource returns the currently active security configuration.

Test Identity Store

Operation

The testIdentityStore operation tests the connection to the input user and role store.

Update Identity Store

Operation

The updateIdentityStore operation updates the location and properties for the user and role store in your ArcGIS Server site.

Update Security Configuration

Operation

The update operation updates the security configuration, including TLS protocols and cipher suites, for your ArcGIS Server site.

Tokens

Resource

The tokens resource represents the token configuration associated with the server.

Update Token Configuration

Operation

The update operation changes the token manager configuration.

Users

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.

Add User

Operation

The add operation adds a user account to the user store.

Assign Roles

Operation

The assignRoles operation assigns roles to a user account when working with a user and role store that support read and write privileges.

Get Privilege for User

Operation

The getPrivilege operation returns the privilege associated with a user.

Get Users

Operation

The getUsers operation gives you a pageable view of users in the user store.

Remove User

Operation

The remove operation removes an existing user account from the user store.

Remove Roles

Operation

The removeRoles operation removes roles that have been previously assigned to a user account.

Search Users

Operation

The search operation searches a specific user or a group of users from the user store.

Update User

Operation

The update operation updates a user account in the user store with new information.

System

NameEndpoint typeDescription

System

Resource

The system resource is a collection of miscellaneous server-wide resources.

Deployment

Resource

The deployment resource returns information about the current deployment configuration.

Configuration Store

Resource

The configstore resource maintains all of the server's configurations.

Edit Configuration Store

Operation

The edit operation updates the configuration store.

Recover Configuration Store

Operation

The recover operation copies the configuration store from the local repository to the shared configuration store location.

Server Directories

Resource

The directories resource lists all the server directories.

Register Directory

Operation

The register operation registers a new server directory.

Recover Services Directory

Operation

The recover operation copies the server directories from the local repository into the shared server directories location.

Server Directory

Resource

The server directory resource returns the properties of an individual directory.

Clean Directory

Operation

The clean operation cleans the content (files and folders) in the directory that has passed its expiration date.

Edit Directory

Operation

The edit operation allows you to change the directory's path as well as its cleanup properties.

Unregister Directory

Operation

The unregister operation unregisters a server directory.

Handlers

Resource

A handlers resource exposes the GIS capabilities of ArcGIS Server through a REST and SOAP interface or API.

Rest Handler

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.

Rest Cache

Resource

The cache operation clears the REST cache.

Clear Rest Cache

Operation

The clear operation clears the cache on all REST handlers in the system.

Services Directory

Resource

The servicesdirectory resource lists properties of the ArcGIS REST API (also known as the Services Directory).

Edit Services Directory

Operation

The edit operation enables or disables the HTML view of the ArcGIS REST API (also known as the Services Directory).

SOAP

Resource

The soap resource provides access to the soaphandlersconfig resource endpoint.

SOAP Handlers Config

Resource

The soaphandlerconfig resource lists the URLs for domains allowed to make cross-domain requests.

Edit SOAP Handlers Config

Operation

The edit operation allows you to restrict cross-domain requests.

Jobs

Resource

The jobs resource is a collection of all the administrative jobs (asynchronous operations) created in your site.

Job

Resource

The job resource represents the asynchronous execution of an operation.

Licenses

Resource

The licenses resource lists the current license level of ArcGIS Server and all authorized extensions.

Platform Services

Resource

The platformservices resource allows you to view and manage your platform services in the ArcGIS Server Administrator Directory.

Compute Platform

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.

Compute Platform Health Check

Operation

The health operation returns information for each machine that participates in the Compute Platform service and details the workers.

Start Compute Platform Service

Operation

The start operation allows you to run your Compute Platform service in the ArcGIS Server Administrator Directory.

Compute Platform Status

Operation

The status resource allows you to view the status of the Compute Platform service.

Stop Compute Platform

Operation

The stop operation allows you to stop your Compute Platform service in the ArcGIS Server Administrator Directory.

Message Bus

Resource

The Message Bus resource allows you to view and manage your Message Bus service in the ArcGIS Server Administrator Directory.

Message Bus Health Check

Operation

The health operation returns information for each machine that participates in the Message Bus service.

Start Message Bus

Operation

The start operation allows you to run your Message Bus service in the ArcGIS Server Administrator Directory.

Stop Message Bus

Operation

The stop operation allows you to stop your Message Bus service in the ArcGIS Server Administrator Directory.

Message Bus Status

Operation

The status resource allows you to view the status of the Message Bus service.

Synchronization 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.

Synchronization Service Health Check

Operation

The health operation returns information for each machine that participates in the Synchronization service.

Synchronization Service Reset

Operation

The reset operation resets the synchronization service and restarts both the Synchronization and Compute Platform services.

Start Synchronization Service

Operation

The start operation allows you to run your Synchronization service in the ArcGIS Server Administrator Directory.

Stop Synchronization Service

Operation

The stop operation allows you to stop your synchronization service in the ArcGIS Server Administrator Directory.

Synchronization Service Status

Operation

The status resource allows you to view the status of the Synchronization service.

Server Properties

Resource

The properties resource is a container for configuration properties that govern the behavior of ArcGIS Server.

Update Server Properties

Operation

The update operation allows you to update the server properties.

Web Adaptors

Resource

The webadaptors resource lists all the web adaptors that have been registered with the site.

Web Adaptor Configuration

Resource

The config resource lists all the configuration parameters shared across all the Web Adaptors in the site.

Update Web Adaptor Configuration

Operation

The update operation changes the configuration parameters and shared key.

Web Adaptor

Resource

The webadaptor resource returns the properties of an individual Web Adaptor, such as the HTTP and HTTPS ports and description.

Unregister Web Adaptor

Operation

The unregister operation unregisters a Web Adaptor, which removes it from the server's trusted list.

Update Web Adaptor

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

NameEndpoint typeDescription

Data

Resource

The data resource provides information about the data holdings of the server.

Compute Ref Count

Operation

The computeTotalRefCount operation computes the total number of references to a given data item that exist on the server.

Federate Data Item

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.

Find Items

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.

Register Item

Operation

The registerItem operation registers a new data item with the server's data store.

Unregister Item

Operation

The unregisterItem operation unregisters a data item that has been previously registered with the server's data store.

Validate All Data Items

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.

Validate Data Item

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.

Big Data File Share Manifest

Resource

The manifest resource returns the manifest resource for a big data file share.

Big Data File Share Manifest Regeneration

Operation

The regenerate operation regenerates the manifest for a big data file share.

Big Data File Share Manifest Update

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.

Big Data File Share Hints

Resource

The hints resource returns the hints for a big data file share.

Big Data File Share Update

Operation

The update operation uploads a hints file for a big data file share item, which will replace the existing hints file.

Datastore Configuration

Resource

The config resource returns information on the data store's configuration properties.

Update Datastore Configuration

Operation

The update operation allows you to update the data store configuration.

Items

Resource

The items resource lists the root data items in the data store.

Lifecycle Information

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.

Edit Data Item

Operation

The edit operation edits the connection information for an existing data item.

Make Data Store Primary Machine

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.

Remove Data Store Machine

Operation

The remove operation removes a standby machine from the Data Store.

Start Data Store Machine

Operation

The start operation starts the database instance running on a Data Store machine.

Stop Data Store Machine

Operation

The stop operation stops the database instance running on a Data Store machine.

Validate Data Store

Operation

The validate operation checks the status of ArcGIS Data Store and provides a health check response.

Uploads

NameEndpoint typeDescription

Uploads

Resource

The uploads resource is a collection of all the items that have been uploaded to the server.

Register Item

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.

Upload Item

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.

Item

Resource

The item resource represents an item that has been uploaded to the server.

Commit Item

Operation

The commit operation completes the upload of all the parts that make an item.

Delete Item

Operation

The delete operation deletes the uploaded item and its configuration.

Upload Part

Operation

The uploadPart operation uploads one part of an item.

Item Parts

Operation

The parts resource lists all the parts associated with an item that have been uploaded to the server.

Logs

NameEndpoint typeDescription

Logs

Resource

The logs resource provides access to operations and resources associated with the server logs.

Clean

Operation

The clean operation forces the server to clean the logs, freeing up disk space.

Count Error Reports

Operation

The countErrorReports operation counts the number of error (crash) reports that have been generated on each machine.

Query

Operation

The query operation provides a way to aggregate, filter, and page through logs across the entire ArcGIS Server site.

Settings

Resource

The settings resource returns the current log settings.

Edit Settings

Operation

The edit operation updates the log settings for the entire server site.

KML

NameEndpoint typeDescription

Kml

Resource

The kml resource is a container for all the .kmz files created on the server.

Create KMZ

Operation

The createKmz operation creates a .kmz file from the input .kml file uploaded to the server.

Kmz File

Resource

The kmz resource returns the .kmz file created from the input .kml file.

Info

NameEndpoint typeDescription

Info

Resource

The info resource returns meta information about the server.

Mode

NameEndpoint typeDescription

Mode

Resource

The mode resource returns the current mode of the site.

Update Site Mode

Operation

The update operation is used to move between the two types of site modes.

Usage Reports

NameEndpoint typeDescription

Usage Reports

Resource

The usagereports resource returns the parameters of a usage report.

Create Usage Report

Operation

The add operation creates a usage report.

Usage Report Settings

Resource

The settings resource returns the current usage report settings.

Edit Usage Report Settings

Operation

The edit operation updates the usage report settings.

Usage Report

Resource

The usagereport resource returns the parameters of a usage report.

Edit Usage Report

Operation

The edit operation updates the usage report.

Query Report Data

Operation

The data operation retrieves server usage data for the report.

Delete Usage Report

Operation

The delete operation deletes the usage report.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.