Edit an existing blackout

patch

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/{blackoutId}

This API edits an existing blackout.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Payload to edit an existing blackout.
Show Source
Match All
Show Source
Nested Schema : excludeTargets
Type: array
List of indirect blackout members which should be excluded from blackout.
Show Source
Nested Schema : excludeTypes
Type: array
List of indirect blackout member type names which should be excluded from blackout.
Show Source
Nested Schema : targets
Type: array
List of targets to be blacked out.
Show Source
Nested Schema : Schedule
Type: object
Schedule details
Show Source
Nested Schema : TargetIdentifier
Type: object
Identifies a target either by name and typeName or by id.
Show Source
Nested Schema : BlackoutTarget
Type: object
Representation of a target contained in a blackout.
Show Source
Examples

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Blackout
Type: object
This is a blackout description.
Show Source
Match All
Show Source
Nested Schema : excludeTargets
Type: array
List of indirect blackout members which should be excluded from blackout.
Show Source
Nested Schema : excludeTypes
Type: array
List of indirect blackout member type names which should be excluded from blackout.
Show Source
Nested Schema : Schedule
Type: object
Schedule details
Show Source
Nested Schema : TargetIdentifier
Type: object
Identifies a target either by name and typeName or by id.
Show Source
Examples

401 Response

client is not authenticated
Body ()
Root Schema : ErrorResponse
Type: object
Error response
Show Source

404 Response

target not found or not authorized
Body ()
Root Schema : ErrorResponse
Type: object
Error response
Show Source

500 Response

internal error serving the request
Body ()
Root Schema : ErrorResponse
Type: object
Error response
Show Source

503 Response

indicates that a required service is not available.
Body ()
Root Schema : ErrorResponse
Type: object
Error response
Show Source
Back to Top