/blackout
/blackout API is deprecated and will be phased out in 5.19.0 release, Please use /freeze API instead.
Methods
Gets the list of Blackout Windows.
NOTE #1: Only users in the BlackoutWindow owner's group may view target details. For users outside of the group: Repository, Assets, ipList, and allIPs will be returned {}, [], "", and "false" respectively.
NOTE #2: If a Repository or Asset associated with a BlackoutWindow has been deleted, the ID will be returned as '-1'. If one has been unshared, the ID will be similarly returned as -1, but the name will signify the Asset ID.
NOTE #3: The "status" field represents if the BlackoutWindow has been disabled via bad Repository and if it has been degrade via Asset. The "functional" field represents if there are any valid target IPs in the BlackoutWindow (allIPs, ipList, assets) in the BlackoutWindow owner's context.
Fields Parameter
Request Parameters
None
Example Response
Adds a Blackout Window.
NOTE: If 'allIPs' is 'false', an 'ipList' and/or at least one 'assets' parameter must be provided. If 'allIPs' is 'true', the back-end will clear the target (ipList, assets, and repository) fields.
Request Parameters
Example Response
/blackout/{id}
Methods
Gets the Blackout Window associated with {id}.
NOTE #1: Only users in the BlackoutWindow owner's group may view target details. For users outside of the group: Repository, Assets, ipList, and allIPs will be returned {}, [], "", and "false" respectively.
NOTE #2: If a Repository or Asset associated with a BlackoutWindow has been deleted, the ID will be returned as '-1'. If one has been unshared, the ID will be similarly returned as -1, but the name will signify the Asset ID.
NOTE #3: The "status" field represents if the BlackoutWindow has been disabled via bad Repository and if it has been degrade via Asset. The "functional" field represents if there are any valid target IPs in the BlackoutWindow (allIPs, ipList, assets) in the BlackoutWindow owner's context.
Fields Parameter
Request Parameters
None
Example Response
Edits the Blackout Window associated with {id}, changing only the passed in fields.
NOTE: Users that are not in the same group as the BlackoutWindow owner can ONLY patch non-target fields (i.e. name, description, and enabled).
Request Parameters
(All fields are optional)
See /blackout::POST for parameters.
Example Response
Deletes the Blackout Window associated with {id}, depending on access and permissions.
Request Parameters
None
Example Response