Deactivating the Blackouts – synthetic API
The POST method of the API deactivates a 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
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.
API | Method | Description |
---|---|---|
Applications | GET | Retrieve the details of applications |
PUT | Update an existing application | |
POST | Create a new application | |
DELETE | Delete an application | |
Execution Plans | GET | Retrieve the details of Execution Plans |
PUT | ||
DELETE | Delete an Execution Plan | |
Scripts | GET | Retrieve the details of scripts |
Locations | GET | Retrieve the details of all locations |
Blackouts | POST | Retrieve the details of Blackouts |
PUT | ||
POST | Activate the Blackout | |
POST | Deactivate the Blackout | |
POST | Delete a Blackout | |
Time Frames | POST | Retrieve the details of Time Frames |
PUT | ||
POST | Delete Time Frames |
To deactivate Blackouts
The API uses the POST method to deactivate the Blackouts. Use the following request syntax:
Sample request with REST client
After accessing the REST client, perform the following steps:
Enter the URL for the API.
An example of a request for deactivating a single Blackout is:https://localhost/tsws/10.0/api/appvis/synthetic/api/blackouts/deactivate
Add a new header row and select Authorization as the header type.
Enter the text authToken followed by the authToken generated through the login API.
- Enter the Blackout ID in the request body.
- Click Send.
Request parameters
Element | Description |
---|---|
authToken | Value of authToken |
Request body
To deactivate, the request body must contain the list of Blackout IDs.
Response
An empty array is returned by the API if the deactivate was successful.
If the deactivate operation fails, the response returns a collection of Blackout IDs that could not be deactivated. For example,
[ "95343ff6-e627-4874-91fd-bc3ed0c83873", "95343ff6-e627-4874-91fd-be3ed0c83872"] |
Related topics