Overview

This article describes the standard format for JetPatch API requests and responses, including required authentication, response components, and provides a practical example using Postman for API testing.

API Request Format

JetPatch API requests are standard HTTPS requests (GET, DELETE, POST, or PUT). 

All API requests must include authentication headers. Requests have parameters and message body content only as specified for each request.

API Response Format

• A response code
• An ETag, in case of a returned task or management service instance 
• Headers:
  • content-length
  • content-type
• In the message body: One or more JSON objects

Example: Using Postman for API GET Requests

Here's an example demonstrating how to utilize the Postman application for an API GET request. 

Ensure that authentication is configured as Digest-Auth, with the username set to "username" in Jetpatch and the password set to the API key generated on the User > Permissions page.