Rest API – User Experience Checks

Retrieve

To retrieve the current information about a UEC in SPM, send unique query parameters in a GET request to the following URL:

http://localhost:38050/web_services/...ver1&name=uec1

Note: Don’t forget to change the domain name (localhost) and query parameter values (account, edge_device, ci, and name) to match your environment and data.

A JSON response will be returned similar in structure to the payload for creation.

Create or Update

To create or update an UEC, POST a JSON document with the specific UEC information to the following URL:

http://[SPM IP address]:38050/web_services/userexptest

Note: Don’t forget to change the domain name (SPM IP address]) to match your environment and data.

You can use the following example as a guide, but note that it does not include all optional properties.

{
  "account_id" : "firescope",
  "edge_device_id" : "edge1",
  "ciid" : "ci1",
  "name" : "uec1",
  "userexpstep" : [{
    "name" : "Step 1",
    "url" : "firescope.com"
  }]
}

Delete

To delete an UEC, send an HTTP DELETE request with the same query parameters as the GET request.

See the Retrieve for the URL format and query parameter descriptions.