ArcGIS Velocity Administrator Directory REST API

The ArcGIS Velocity Administrator Directory allows you to administer ArcGIS Velocity programmatically. This means that you can manage your server using any framework that can make HTTP requests.

The API is organized into resources and operations. Resources are entities in ArcGIS Velocity that contain information and have a well-defined state. Operations act on these resources and update their information or state. Resources and operations are hierarchical and have unique URLs.

Getting started

The hierarchical root of the ArcGIS Velocity Administrator API begins with a well-defined URL that is called the site URL. Typically, this is accessible at the following location:

Administrator
Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin

The various resources and operations that are used by the Administrator API are organized hierarchically from the site URL. To access a resource or invoke an operation, you must create a request by doing the following:

  1. Construct a URL to the selected resource or operation as defined in the API Reference.
  2. Provide the relevant parameters in their specified format.
  3. Access the URL over the prescribed HTTP method (typically GET or POST).

The API is stateful, which means actions such as POST requests are recorded in the server's state. Each request must contain all the necessary information for successful processing. The server will process each request and return a well-defined response.

Administrator Directory

The ArcGIS Velocity Administrator Directory, which is installed with each instance of ArcGIS Velocity, is a simple HTML website that allows you to interact with the resources and operations exposed by the API. This can be helpful when building scripts for administrative tasks and applications. The directory is accessible by browsing the site URL in a web browser.

You can access the directory at a URL, such as https://organization.example.com/<context>/admin.

Manage API access

ArcGIS Enterprise provides multiple ways for organizations to manage how their members access and interact with the portal and its content. One way to manage member access is by creating custom roles, which provides fine-grained control over the privileges that are granted to organization members. Privileges determine which tasks and workflows a member can perform within an organization. For example, a user assigned a custom role with the administrative privilege to create geoprocessing webhooks can create and manage webhooks for geoprocessing services, whereas a user assigned a custom role with the administrative privilege to manage the organization's security can set the security policies and manage SSL certificates.

Access to the ArcGIS Velocity Administrator API is also dependent on the privileges a member is assigned. Access to the API is restricted to:

  • Users with the default administrator role

  • Users assigned a custom role with the Security and infrastructure and Servers privileges

  • The Velocity Primary Site Administrator (PSA) account.

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