Rest API

Hawkeye solution has a web-based GUI. You can access functions of Hawkeye without the web user interface using Rest APIs directly.

List of supported Rest APIs are available under Documentation > Rest API. Swagger is a tool, which is used to visualize and interact with the API's resources without applying any implementation logic.

You can download open API spec from the <open-api.yaml> link at the top of Documentation > Rest API and use it in any other tool.

Example: Rest API to get a list of test results.

Below is the image of test result request. Select Try it out button on the tool to run it without implementing on client side for testing.

Below is image of test result response showing JSON format to be returned on the request call.

To check the schema of response and its elements click on schema link as highlighted below

How to create a new test:

The Tests topology field (NodeToNode, RealService, Mesh) in a request defines the type of test that is going to be created.

Example requests for each test topology can be downloaded from here.

The parameters array contains list of basic and pairs (for NodeToNode and Mesh) of a testtype. Use /api/testtypes/{id}/parameters API where {id} is testtype Id to fetch list of supported test parameters for a specific test type.

The threshold and alarm are optional data. Use it if client wants to change alarm or threshold’s default settings. Outlier under threshold is also optional.

The startDate and endDate fields are in UTC time format YYYY-MM-DDTHH:MM:SSZ