Deleting the Blackouts – synthetic API

The POST method of the API deletes single or list of Blackouts.

Before you begin

You must obtain an authToken by using the login API. The token authenticates the user performing the operation. For details, see TSWS authentication .

Synthetic configuration APIs


  • 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.

GETRetrieve the details of applications

Update an existing application

POSTCreate a new application
DELETEDelete an application

Execution Plans

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


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

Time Frames

POSTRetrieve the details of Time Frames
POSTDelete Time Frames

To delete Blackouts

The API uses the POST method to delete the Blackouts. 

Request syntax


Request parameters


Value of authToken

Sample request with REST client

After accessing the REST client, perform the following steps:

  1. Enter the URL for the API.
    The generic format is as follows:
  2. Add a new header row and select Authorization as the header type.
  3. Enter the text authToken followed by the authToken generated through the login API. 
  4. Enter a single or list of Blackout IDs in the request body.
  5. Click Send.

Request body

To delete, the request body must contain a single or the list of Blackout IDs.

["95343ff6-e627-4874-91fd-bc3ed0c83873", "95343ff6-e627-4874-91fd-be3ed0c83872"]


If the delete operation is successful, the response is an empty array.

If the delete operation fails, the response returns a collection of Blackout IDs that could not be deleted. For example, 

 [ "95343ff6-e627-4874-91fd-bc3ed0c83873", "95343ff6-e627-4874-91fd-be3ed0c83872"]

Related topics


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