API Architecture

Developers can implement JetPatch API requests in client scripts written in any language that can send http requests and parse responses.

 API requests can perform various tasks with:

• Endpoints (in the API called servers)
• Endpoint credentials
• The JetPatch connector on each endpoint
• Stored management services and deployed management service instances
• Management server registration
• Asynchronous tasks from previous requests

In addition to the API resources described in this guide, resources for health scripts and for discovery resources may be available. To use these, please contact JetPatch support.

An additional resource type is an asynchronous task. A task is created upon any request that requires action on an endpoint, and the task URL is provided in the response to the originating request.

The only resource that should be hard-coded in client code should be the API root, used once for retrieving collection URLs. These collection URLs should be stored by the client and subsequently used for other requests, which in turn will provide the client with objects including additional resource URLs for use in additional requests.