REST API Management Responsibilities

The aP Connect Agent REST API allows you to use HTTP methods to retrieve information about your aP Connect Agent and Workflows or to initiate actions, such as service shutdowns or workflow invocations and cancellations, from a machine or server that is networked to your Agent.

Note:

An aPriori System Services engagement is recommended for leveraging the aP Connect Agent REST API for your file system deployment. For more information, please contact aPriori Customer Support.

A representational state transfer application program interfaces (REST API) allows one server or machine in a network to perform operations on a second server or machine in the network by using the hypertext transfer protocol (HTTP) methods. The aP Connect Agent REST API uses the HTTP GET and POST methods to allow you to retrieve Agent and Workflow information or to initiate actions from a server or machine that shares a network with the server or machine that contains your aP Connect Agent.

For information about the REST API endpoints, see the aP Connect Agent REST API Reference Guide.