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.

Synthetic Blackouts in versions 11.3.02 and later

  • Starting from version 11.3.02, the Blackout configuration is no longer part of the Execution Plan APIs. You can use the dedicated Synthetic Blackout and Synthetic Time Frames APIs for that purpose.
  • If you are using version 11.3.01 or earlier, you can continue to use the Execution Plan APIs to access the Blackouts.

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:

Notes:

  • If you have upgraded to version 11.3.02, you can access the Synthetic Blackout and Synthetic Time Frames APIs listed in this table.
  • If you are using version 11.3.01 or earlier, you can continue to use the Execution Plan APIs to access the Blackouts.
APIMethodDescription
Applications

GETRetrieve the details of applications
PUT

Update an existing application

POSTCreate a new application
DELETEDelete an application

Execution Plans



GETRetrieve the details of Execution Plans
PUT
DELETEDelete an Execution Plan
ScriptsGETRetrieve the details of scripts
LocationsGETRetrieve the details of all locations

Blackouts

POSTRetrieve the details of Blackouts
PUT
POSTActivate the Blackout
POSTDeactivate the Blackout
POSTDelete a Blackout

Time Frames

POSTRetrieve the details of Time Frames
PUT
POSTDelete Time Frames

Related topic

Developing

Was this page helpful? Yes No Submitting... Thank you

Comments