List blackouts
get
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts
This API returns a list of blackouts based on supplied criteria.
Request
Query Parameters
-
include: string
Used to include extra information in the result. Right now the only value allowed is "total" which will computes total number of blackouts matching the criteria.Example:
total
-
limit: integer(int32)
Minimum Value:
1
Maximum Value:2000
to limit the number of rows returned. If the result set is greater follow the previous and next links in the results.Example:20
-
name: array[string]
name of the blackout
-
nameMatches: array[string]
Name pattern of the blackout
-
owner: array[string]
Owner of the blackout
-
page: string
system generated page token used in the self, next and previous links.
-
reason: array[string]
Reason for the blackout
-
sort: string
The sort field and direction. Allowed sort fields are "name", "status", "id", "timeToStart" and "timeToEnd". Allowed directions are ASC and DESC. Default is "name:ASC".Example:
status:ASC,name:DESC
-
status: array[string]
Status of the blackout (SCHEDULED, START_PROCESSING, START_PARTIAL, START_FAILED, STARTED, STOP_PENDING, STOP_FAILED, STOP_PARTIAL, EDIT_FAILED, EDIT_PARTIAL, EDIT_PENDING, STOPPED, ENDED, END_PARTIAL)
-
targetId: string
Used to only list blackouts which have the target of the given id as direct blackout member.Example:
ADLKFIDYFSDHFISDOFSDF
-
timeToEndAfter: string
Start of time period for when blackouts are scheduled to end. Timestamps are with minute accuracy and can provide timezone.Example:
2021-03-01T21:23+01:00
-
timeToEndBefore: string
End of time period for when blackouts are scheduled to end. Timestamps are with minute accuracy and can provide timezone.Example:
2021-03-01T21:23+01:00
-
timeToStartAfter: string
Start of time period for when blackouts are scheduled to start. Timestamps are with minute accuracy and can provide timezone.Example:
2021-03-01T21:23+01:00
-
timeToStartBefore: string
End of time period for when blackouts are scheduled to start. Timestamps are with minute accuracy and can provide timezone.Example:
2021-03-01T21:23+01:00
-
type: array[string]
Type of the blackout, valid values are PATCHING, NOTIFICATION or NOTIFICATION_MAINTENANCE
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : BlackoutCollection
Type:
object
This is the representation of a list of blackout summaries.
Show Source
-
count(required): integer
Number of blackouts in this pageExample:
1
-
items(required): array
items
Blackout summaries
-
links(required): object
links
Result set navigation links.
-
total: integer
Total number of blackouts in this request. This has to be explicitly included in the request.
Nested Schema : items
Type:
array
Blackout summaries
Show Source
-
Array of:
object BlackoutSummary
This is the representation of the Blackout summary.
Nested Schema : BlackoutSummary
Type:
object
This is the representation of the Blackout summary.
Show Source
-
id(required): string
Blackout IDExample:
D91786E288D35455C3ADA1B329B49BB5
-
links(required): object
links
Target related links.
-
name(required): string
Blackout NameExample:
my_blackout
-
owner(required): string
Owner of the blackout.Example:
scott
-
reason: string
blackout reasonExample:
Network Outage
-
status(required): string
Allowed Values:
[ "SCHEDULED", "START_PROCESSING", "START_PARTIAL", "START_FAILED", "STARTED", "STOP_PENDING", "STOP_FAILED", "STOP_PARTIAL", "EDIT_FAILED", "EDIT_PARTIAL", "EDIT_PENDING", "STOPPED", "ENDED", "END_PARTIAL" ]
Blackout status. -
statusDisplayName: string
Status display name in the cient locale.
-
type(required): string
Default Value:
PATCHING
Allowed Values:[ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]
Type of the blackout. -
typeDisplayName: string
Blackout type display name in the client localeExample:
Benachrichtigungsblackout
Match All
Show Source
Nested Schema : Schedule
Type:
object
Schedule details
Show Source
-
isTargetZone: boolean
To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition
-
recurring: string
Frequency at which the operation must be executed repeatedlyExample:
frequency:weekly;days:2,
-
scheduleType: string
Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON.
-
startGracePeriodInMinutes: integer
Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.Example:
60
-
timeToEnd: string
(date-time)
End time
-
timeToStart: string
(date-time)
Start time
Nested Schema : Link
Type:
object
Represents a link(could be self, previous or next)
Show Source
-
href: string
URL for LinkExample:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
Examples
400 Response
in the case of illegal arguments like unsupported sort direction
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
client is not authenticated
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
internal error serving the request
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
indicates that a required service is not available.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string