About the Endpoint Response
When you run an endpoint call in the FireMon API, it returns a cURL, request URL, response body, response code, and response headers. The list below defines the response sections.
- cURL—the cURL allows you to query the endpoint URL from a command line
- Request URL—the URL of the call
- Response Body—this is the content that is produced as a result of your endpoint, presented as a structured set of the endpoint parameters and their values in JSON format. For example, when you use the GET/domain/{domainID}/assessment endpoint, the response body is a list of all the assessments in the specified domain and details, like ID or name. A GET endpoint returns detailed information on the SIP element you are querying, while all other endpoints return. The response body for a POST, PUT, or DELETE endpoint includes only a message stating whether the endpoint passed or failed.
- Response Code—the response code is a three-digit number returned by the API server to notify you how a request was received. For a definition of response codes, see the Response Codes topic.
- Response Headers—the metadata returned by the API server and appended to the requested content of the endpoint, such as the date, size, and type of file
