Managing synthetic configurations with APIs


The APIs for managing your synthetic configurations use Representational State Transfer (REST) web services that enable you to retrieve, update, and delete synthetic configuration data for your applications. You can integrate the APIs with your other business applications.

Before you begin

All of the APIs require an authorization token for authenticating the user. Obtain an authToken by using the login API. For details, see TSWS authentication.

The following synthetic configuration APIs are provided:

API

Method

Description

Applications

GET

Retrieve the details of one application or all applications

PUT

Update an existing application

POST

Create a new application

DELETE

Delete an application

Execution Plans

  

GET

Retrieve the details of one or more Execution Plans

PUT

Create a new Execution Plan or
Update an existing Execution Plan

DELETE

Delete an Execution Plan

Scripts

GET

Retrieve the details of one script or all scripts

Locations

GET

Retrieve the details of all locations

Related topic

Developing

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*