Create REST API Monitoring

How to Create a REST API Monitor?

To optimize your REST APIs' performance, follow these simple steps for configuring a REST API Monitor:

1. Begin by onboarding to PerfAgents Uncloud. Click here for directions.

2. Once onboarded, click on "Create Monitoring" from the sidebar.

3. Select "REST API" and click "Create" to access the Configuration page.

4. Input one or more valid REST endpoints of the API you wish to monitor.

Supported methods include GET, POST, PUT, and DELETE.

1. Check "Advanced Options" to customize Params, Authorization, Headers, and Body. Here, you'll also find options for defining Assertions.

• Params: Add Key-Value pairs to send data.

• Authorization: Select the desired Type from No Auth, Auth Token, Base Auth, and API Key.

• Header: Add Key-Value pairs for custom headers.

• Body: Choose from form-data, x-www-form-urlencoded, or raw data for sending information.

Assertions:

• Name: Give a descriptive name.

• Target: Choose from Header, Status, Size, or JSON Body.

• Assert Type: Select the appropriate option based on your chosen target (Equals/Not Equal).

1. Choose between "Run On Demand" or "Select Time Period" and set the frequency accordingly.

2. Set the location as either Public or Private, and select your desired region(s) from AWS, Azure, or both.

3. Specify alert criteria if necessary and select a convenient app for integration to stay notified about your monitoring.

4. Click "Submit" to complete the setup.

You can opt for integrations globally or choose a tool that suits your needs. For more details about integrations, click here.

API Chaining

Our REST API monitoring now includes an API chaining feature, which allows you to utilize the output of a top-level API in the configurations of subsequent URL

1. Access the previous URL response using, $api[index].response. <data|headers|statusCode>

e.g:

• {{$api[0].response.data.first_name}}

• {{$api[0].response.headers['Content-Type']}}

• {{$api[0].response.statusCode}}

You can also test your APIs before setting up monitoring by using the Test button.

Users have the option to create REST API monitoring through the API by simply clicking on the 'Using API' label, accessed through the drop-down arrow icon.

Congratulations! Enjoy seamless monitoring of your REST APIs and receive valuable insights to optimize your operations. Happy Monitoring!