Blackout REST Endpoints

Sort by

Task Path Method

Blackout

APIs to manage blackouts.

Check whether blackout diagnostics is enabled

Method: get

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/enableDiagnostics

Check whether retroactive blackout creation is enabled

Method: get

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/enableRetroactiveBlackout

Create a blackout

Method: post

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts

Create a new blackout reason

Method: post

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/reasons

Create a retroactive blackout

Method: post

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/retroactiveBlackout

Delete a blackout by blackout ID

Method: delete

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

Delete a blackout reason by reason ID

Method: delete

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/reasons/{reasonId}

Enable or disable blackout diagnostics

Method: post

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/enableDiagnostics

Enable or disable retroactive blackouts

Method: post

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/enableRetroactiveBlackout

Get blackout details by blackout ID

Method: get

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

Get blackout settings

Method: get

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/settings

Get blackout statistics

Method: get

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/dashboard

List blackout reasons

Method: get

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/reasons

List blackouts affecting a target by target ID

Method: get

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/targets/{targetId}

List blackouts by supported criteria

Method: get

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts

List targets in a blackout

Method: get

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

List targets in any blackout

Method: get

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/targets

Stop a blackout by blackout ID

Method: post

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/{blackoutId}/actions/stop

Update a blackout by blackout ID

Method: patch

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

Update blackout settings

Method: post

Path: https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/settings