Send Docs Feedback

Apigee Test is an Apigee Labs feature. It's available free of charge, functions “as is,” and is not supported. There are no service-level agreements (SLAs) for bug fixes. Get help in the Apigee Community.

Create a Probe

Resource Summary

Security

Content Type

application/json

Category

Apigee Test,

CreateaProbe

POST

Create a Probe

Probes automatically execute Test Cases at specified intervals, notify you on failures or poor API performance, capture API call details, and graph analytics on API performance and call success rates. (Executing Test Cases with webhooks provides none of these features.) 

 

There are a lot of configuration possibilities for Probes, so before creating a Probe with this API, you may want to create one in the UI to better understand the concepts.

 

Also, a good way to figure out how to create the Probe you want with the API is to first create one in the UI, then run the List Probes API to get its ID, then run the Get a Probe API to see its structure. For more information on creating Probes with the UI, see Probes.

 

When you create a Probe with the API, you'll need to provide the ID of a Test Case (required) and the ID of a Config Set (optional).

Resource URL

https://api.test.apigee.com/v1 /organizations/{org_name}/probes

Header Parameters

Name Values Description
Content-Type
(required)

application/json

Request Body

For information on Probes beyond what's covered here, see Probes.

Property Description
configSetId Optional. If you want to use a Config Set to set Test Case variables, enter the ID of the Config Set. To get Config Set IDs, use the List Config Sets API.
testcaseId Required. The ID of the Test Case you want the Probe to execute. To get Test Case IDs, use the List Test Cases API.
locations

Geographical locations from which the Probe is executed. Valid values:

  • pdx - Oregon - USA
  • iad - Washington, D.C. - USA
  • dub - Dublin - Ireland
  • syd - Sydney - Australia
  • tyo - Tokyo - Japan
schedule

The time interval between automatic Probe execution. Valid settings:

  • 30 seconds
  • 1 minutes
  • 5 minutes
  • 15 minutes
  • 30 minutes
  • 1 hours
  • Example:

"schedule": {
    "unit": "seconds",
    "interval": "30"
  }
  
alertConditions

Set conditions that trigger notifications. (See the sample payload for an example of each alert condition.) Valid settings are:

  • failures with a threshold number. If the Probe fails the number of consecutive times indicated by the threshold, Apigee Test sends a notification.
  • latency with a value in milliseconds and a threshold number. If the total execution time of all combined Steps in the Probe exceeds the number of milliseconds the specified number of times in a row, Apigee Test sends a notification.
  • anomaly with a boolean of true or false. If Apigee Test detects uncharacteristically high latency over a period of time, it sends a notification.
notificationChannels

At least one notification channel is required if you set one or more alert conditions. You can also create these as placeholders even if you don't set any alert conditions. No notifications will be sent until alert conditions are triggered. Supported notification channels/types are:

  • email with an array of email addresses
  • hipchat with room and accessToken
  • slack with a webHook URL
  • pagerduty with a token and serviceKey

See the sample payload for an example of each notification channel.

inActive
  • false to make the Probe active.
  • true to make the Probe inactive. Inactive Probes aren't executed.

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

Working...

Help or comments?