Activating the Blackouts – synthetic API
POST method of the API activates 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 activate Blackouts
The API uses the POST method to activate 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 activating 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 activate, the request body must contain a single or list of Blackout IDs.
An empty array is returned by the API if the activate was successful.
If the activate operation fails, the response returns a collection of Blackout IDs that could not be activated. For example,