Deactivating the Blackouts – synthetic API
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
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:
Add a new header row and select Authorization as the header type.
- Enter the text authToken followed by the
generated through the
- Enter the Blackout ID in the request body.
- Click Send.
To deactivate, the request body must contain the list of Blackout IDs.
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,