Jump to

• Request
• Response

Create a new blackout

post

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

This API creates a new blackout.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Payload to create a new blackout.

Show Source

• description: string
  Blackout related comments.

  Example: A regular maintenance scheduled blackouts for oemrep database.
• excludeTargets: array excludeTargets
  List of indirect blackout members which should be excluded from blackout.
• excludeTypes: array excludeTypes
  List of indirect blackout member type names which should be excluded from blackout.
• isAllowJobs: boolean
  Default Value: false

  Indicate of jobs on targets are still allowed to be executed.
• isFullBlackoutOnHost: boolean
  Default Value: false

  Indicate that all targets on host are under blackout.
• name(required): string
  Name of the blackout
• reasonId: number
  reason id for the blackout
• targets(required): array targets
  List of targets to be blacked out.
• type: string
  Default Value: PATCHING

  Allowed Values: [ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]

  Type of the blackout.

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to create a new blackout.",
    "required":[
        "name",
        "targets"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "reasonId":{
            "type":"number",
            "description":"reason id for the blackout"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database."
        },
        "targets":{
            "type":"array",
            "description":"List of targets to be blacked out.",
            "items":{
                "$ref":"#/components/schemas/BlackoutTarget"
            }
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicate of jobs on targets are still allowed to be executed.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicate that all targets on host are under blackout.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Match All

Payload to create a new blackout.

Show Source

• object Schedule
  This represents a schedule object to schedule blackouts.

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to create a new blackout.",
    "required":[
        "name",
        "targets"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "reasonId":{
            "type":"number",
            "description":"reason id for the blackout"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database."
        },
        "targets":{
            "type":"array",
            "description":"List of targets to be blacked out.",
            "items":{
                "$ref":"#/components/schemas/BlackoutTarget"
            }
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicate of jobs on targets are still allowed to be executed.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicate that all targets on host are under blackout.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Nested Schema : excludeTargets

Type: array

List of indirect blackout members which should be excluded from blackout.

Show Source

• Array of: object TargetIdentifier
  Identifies a target either by name and typeName or by id.

{
    "type":"array",
    "description":"List of indirect blackout members which should be excluded from blackout.",
    "items":{
        "$ref":"#/components/schemas/TargetIdentifier"
    }
}

Nested Schema : excludeTypes

Type: array

List of indirect blackout member type names which should be excluded from blackout.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of indirect blackout member type names which should be excluded from blackout.",
    "items":{
        "type":"string"
    }
}

Nested Schema : targets

Type: array

List of targets to be blacked out.

Show Source

• Array of: object BlackoutTarget
  Representation of a target contained in a blackout.

{
    "type":"array",
    "description":"List of targets to be blacked out.",
    "items":{
        "$ref":"#/components/schemas/BlackoutTarget"
    }
}

Nested Schema : Schedule

Type: object

This represents a schedule object to schedule blackouts.

Show Source

• repeat: object Repeat
  Describes repetition of a blackout.
• timeToStart: string
  Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).

  Example: 2023-08-24T14:54-02:00

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
            "example":"2023-08-24T14:54-02:00"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

Match One Schema

Show Source

• object TimeToEnd
  An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).
• object Duration
  A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
            "example":"2023-08-24T14:54-02:00"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

Nested Schema : TargetIdentifier

Type: object

Identifies a target either by name and typeName or by id.

Show Source

• id: string
  Target ID
• name: string
  Target Name
• typeName: string
  Target Type Name

{
    "type":"object",
    "description":"Identifies a target either by name and typeName or by id.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Target ID"
        },
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        }
    }
}

Nested Schema : BlackoutTarget

Type: object

Representation of a target contained in a blackout.

Show Source

• id: string
  target id
• isIncludeMembers: boolean
  Default Value: true

  Indicates if members of the target should be included in the blackout.
• name: string
  Target Name
• typeName: string
  Target Type Name

{
    "x-em-sdk-level":"emSDK",
    "description":"Representation of a target contained in a blackout.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        },
        "id":{
            "type":"string",
            "description":"target id"
        },
        "isIncludeMembers":{
            "type":"boolean",
            "description":"Indicates if members of the target should be included in the blackout.",
            "default":true
        }
    }
}

Nested Schema : Repeat

Type: object

Describes repetition of a blackout.

Show Source

• timeToEndRepeat: string
  End time of the repetition with timezone. Timestamps are with minute accuracy.

  Example: 2023-08-24T14:54-02:00

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

Match One Schema

Show Source

• object DaysOfYear
  List of days of year.
• object DaysOfMonth
  List of days of month in range 1-31 or -1 for last day of the month.
• object DaysOfWeek
  List of days of week.
• object EveryNWeeks
  Repeat every n weeks.
• object EveryNDays
  Repeat every n days.
• object EveryNHours
  Repeat every n hours.
• object EveryNMinutes
  Repeat every n minutes, minimal value is 2.

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

Nested Schema : TimeToEnd

Type: object

An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).

Show Source

• timeToEnd(required): string
  An end time

  Example: 2023-08-23T14:54+01:00

{
    "type":"object",
    "required":[
        "timeToEnd"
    ],
    "description":"An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
    "properties":{
        "timeToEnd":{
            "type":"string",
            "description":"An end time",
            "example":"2023-08-23T14:54+01:00"
        }
    }
}

Nested Schema : Duration

Type: object

A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.

Show Source

• durationHours: integer
  Duration of the blackout in hours.

  Example: 2
• durationMinutes: integer
  Duration of the blackout in minutes.

  Example: 25

{
    "type":"object",
    "description":"A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.",
    "properties":{
        "durationMinutes":{
            "type":"integer",
            "description":"Duration of the blackout in minutes.",
            "example":"25"
        },
        "durationHours":{
            "type":"integer",
            "description":"Duration of the blackout in hours.",
            "example":"2"
        }
    }
}

Nested Schema : DaysOfYear

Type: object

List of days of year.

Show Source

• daysOfYear: array daysOfYear
  List of days of the year.

{
    "type":"object",
    "description":"List of days of year.",
    "properties":{
        "daysOfYear":{
            "type":"array",
            "description":"List of days of the year.",
            "items":{
                "type":"object",
                "properties":{
                    "month":{
                        "type":"integer",
                        "description":"Month in range of 1-12."
                    },
                    "day":{
                        "type":"integer",
                        "description":"Day in range 1-31 or -1 for last day of the month."
                    }
                }
            }
        }
    }
}

Nested Schema : DaysOfMonth

Type: object

List of days of month in range 1-31 or -1 for last day of the month.

Show Source

• daysOfMonth: array daysOfMonth
  List of days of the month (1 based).

{
    "type":"object",
    "description":"List of days of month in range 1-31 or -1 for last day of the month.",
    "properties":{
        "daysOfMonth":{
            "type":"array",
            "description":"List of days of the month (1 based).",
            "items":{
                "type":"integer"
            },
            "example":[
                "1",
                "15"
            ]
        }
    }
}

Nested Schema : DaysOfWeek

Type: object

List of days of week.

Show Source

• daysOfWeek: array daysOfWeek
  List of days of week (localized short names).

{
    "type":"object",
    "description":"List of days of week.",
    "properties":{
        "daysOfWeek":{
            "type":"array",
            "description":"List of days of week (localized short names).",
            "items":{
                "type":"string",
                "enum":[
                    "MO",
                    "TU",
                    "WE",
                    "TH",
                    "FR",
                    "SA",
                    "SU"
                ]
            },
            "example":[
                "MO",
                "TH"
            ]
        }
    }
}

Nested Schema : EveryNWeeks

Type: object

Repeat every n weeks.

Show Source

• everyNWeeks: integer
  Repeat interval in weeks.

  Example: 2

{
    "type":"object",
    "description":"Repeat every n weeks.",
    "properties":{
        "everyNWeeks":{
            "type":"integer",
            "description":"Repeat interval in weeks.",
            "example":"2"
        }
    }
}

Nested Schema : EveryNDays

Type: object

Repeat every n days.

Show Source

• everyNDays: integer
  Repeat interval in days, minimal value is 1.

  Example: 5

{
    "type":"object",
    "description":"Repeat every n days.",
    "properties":{
        "everyNDays":{
            "type":"integer",
            "description":"Repeat interval in days, minimal value is 1.",
            "example":"5"
        }
    }
}

Nested Schema : EveryNHours

Type: object

Repeat every n hours.

Show Source

• everyNHours: integer
  Repeat interval in hours.

  Example: 2

{
    "type":"object",
    "description":"Repeat every n hours.",
    "properties":{
        "everyNHours":{
            "type":"integer",
            "description":"Repeat interval in hours.",
            "example":"2"
        }
    }
}

Nested Schema : EveryNMinutes

Type: object

Repeat every n minutes, minimal value is 2.

Show Source

• everyNMinutes: integer
  Repeat interval in minutes.

  Example: 45

{
    "type":"object",
    "description":"Repeat every n minutes, minimal value is 2.",
    "properties":{
        "everyNMinutes":{
            "type":"integer",
            "description":"Repeat interval in minutes.",
            "example":"45"
        }
    }
}

Nested Schema : daysOfYear

Type: array

List of days of the year.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"List of days of the year.",
    "items":{
        "type":"object",
        "properties":{
            "month":{
                "type":"integer",
                "description":"Month in range of 1-12."
            },
            "day":{
                "type":"integer",
                "description":"Day in range 1-31 or -1 for last day of the month."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• day: integer
  Day in range 1-31 or -1 for last day of the month.
• month: integer
  Month in range of 1-12.

{
    "type":"object",
    "properties":{
        "month":{
            "type":"integer",
            "description":"Month in range of 1-12."
        },
        "day":{
            "type":"integer",
            "description":"Day in range 1-31 or -1 for last day of the month."
        }
    }
}

Nested Schema : daysOfMonth

Type: array

List of days of the month (1 based).

Show Source

• Array of: integer

{
    "type":"array",
    "description":"List of days of the month (1 based).",
    "items":{
        "type":"integer"
    },
    "example":[
        "1",
        "15"
    ]
}

Example:

[
    "1",
    "15"
]

Nested Schema : daysOfWeek

Type: array

List of days of week (localized short names).

Show Source

• Array of: string
  Allowed Values: [ "MO", "TU", "WE", "TH", "FR", "SA", "SU" ]

{
    "type":"array",
    "description":"List of days of week (localized short names).",
    "items":{
        "type":"string",
        "enum":[
            "MO",
            "TU",
            "WE",
            "TH",
            "FR",
            "SA",
            "SU"
        ]
    },
    "example":[
        "MO",
        "TH"
    ]
}

Example:

[
    "MO",
    "TH"
]

Examples

Select an example Create indefinite immediate blackout Create a one time blackout with start and end time Create a one time blackout with start time and duration Create a repeating blackout which repeats every 2 hours forever Create a repeating blackout which repeats every 2 days and ends at specified time Create a repeating blackout which repeats at specific days of the week Create a repeating blackout which repeats at first and 15th day of the month Create a repeating blackout which repeats at 15th and last day of the month Create a repeating blackout which repeats at specific days of the year Create a notification blackout but allow jobs to be run Create a blackout on large system excluding all databases which are indirect members but include one specific db Create a blackout on large system excluding specific indirect blackout members Create a blackout on a host and request to fully blackout all targets on host

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : Blackout

Type: object

This is a blackout description.

Show Source

• agent: string
  Name of the agent starting the blackout.

  Example: hostName:1838
• creationTimeToEnd: string
  The timeToEnd given at blackout creation time.
• creationTimeToStart: string
  The timeToStart given at blackout creation time.
• description: string
  Blackout related comments.

  Example: A regular maintenance scheduled blackouts for oemrep database
• excludeTargets: array excludeTargets
  List of indirect blackout members which should be excluded from blackout.
• excludeTypes: array excludeTypes
  List of indirect blackout member type names which should be excluded from blackout.
• id(required): string
  Blackout ID

  Example: D91786E288D35455C3ADA1B329B49BB5
• isAllowJobs: boolean
  Default Value: false

  Indicates if job executions on targets are allowed during blackout.
• isFullBlackoutOnHost: boolean
  Default Value: false

  Indicates if all targets on hosts in the blackout are blacked out too.
• links(required): object links
  Blackout related links.
• name(required): string
  Blackout Name

  Example: my_blackout
• owner(required): string
  Owner of the blackout

  Example: scott
• reason: string
  Blackout reason

  Example: Host patching
• 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.
• type(required): string
  Default Value: PATCHING

  Allowed Values: [ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]

  Type of the blackout.

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a blackout description.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "owner",
        "links"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout",
            "example":"scott"
        },
        "reason":{
            "type":"string",
            "description":"Blackout reason",
            "example":"Host patching"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database"
        },
        "agent":{
            "type":"string",
            "description":"Name of the agent starting the blackout.",
            "example":"hostName:1838"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicates if job executions on targets are allowed during blackout.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicates if all targets on hosts in the blackout are blacked out too.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        },
        "creationTimeToStart":{
            "type":"string",
            "description":"The timeToStart given at blackout creation time."
        },
        "creationTimeToEnd":{
            "type":"string",
            "description":"The timeToEnd given at blackout creation time."
        },
        "links":{
            "type":"object",
            "description":"Blackout related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                },
                "targets":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the targets under blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                            }
                        }
                    ]
                }
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Match All

This is a blackout description.

Show Source

• object Schedule
  This represents a schedule object to schedule blackouts.

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a blackout description.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "owner",
        "links"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout",
            "example":"scott"
        },
        "reason":{
            "type":"string",
            "description":"Blackout reason",
            "example":"Host patching"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database"
        },
        "agent":{
            "type":"string",
            "description":"Name of the agent starting the blackout.",
            "example":"hostName:1838"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicates if job executions on targets are allowed during blackout.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicates if all targets on hosts in the blackout are blacked out too.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        },
        "creationTimeToStart":{
            "type":"string",
            "description":"The timeToStart given at blackout creation time."
        },
        "creationTimeToEnd":{
            "type":"string",
            "description":"The timeToEnd given at blackout creation time."
        },
        "links":{
            "type":"object",
            "description":"Blackout related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                },
                "targets":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the targets under blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                            }
                        }
                    ]
                }
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

Nested Schema : excludeTargets

Type: array

List of indirect blackout members which should be excluded from blackout.

Show Source

• Array of: object TargetIdentifier
  Identifies a target either by name and typeName or by id.

{
    "type":"array",
    "description":"List of indirect blackout members which should be excluded from blackout.",
    "items":{
        "$ref":"#/components/schemas/TargetIdentifier"
    }
}

Nested Schema : excludeTypes

Type: array

List of indirect blackout member type names which should be excluded from blackout.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of indirect blackout member type names which should be excluded from blackout.",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: object

Blackout related links.

Show Source

• self: self
• targets: targets

{
    "type":"object",
    "description":"Blackout related links.",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the blackout."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                    }
                }
            ]
        },
        "targets":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the targets under blackout."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                    }
                }
            ]
        }
    }
}

Nested Schema : Schedule

Type: object

This represents a schedule object to schedule blackouts.

Show Source

• repeat: object Repeat
  Describes repetition of a blackout.
• timeToStart: string
  Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).

  Example: 2023-08-24T14:54-02:00

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
            "example":"2023-08-24T14:54-02:00"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

Match One Schema

Show Source

• object TimeToEnd
  An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).
• object Duration
  A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.

{
    "x-em-sdk-level":"emSDK",
    "description":"This represents a schedule object to schedule blackouts.",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time of the blackout with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
            "example":"2023-08-24T14:54-02:00"
        },
        "repeat":{
            "$ref":"#/components/schemas/Repeat"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/TimeToEnd"
        },
        {
            "$ref":"#/components/schemas/Duration"
        }
    ]
}

Nested Schema : TargetIdentifier

Type: object

Identifies a target either by name and typeName or by id.

Show Source

• id: string
  Target ID
• name: string
  Target Name
• typeName: string
  Target Type Name

{
    "type":"object",
    "description":"Identifies a target either by name and typeName or by id.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Target ID"
        },
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        }
    }
}

Nested Schema : self

Match All

Link to the blackout.

Show Source

• object Link
  A link referencing a REST API.
• Link to the blackout.
• Example: { "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the blackout."
        },
        {
            "example":{
                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
            }
        }
    ]
}

Nested Schema : targets

Match All

Link to the targets under blackout.

Show Source

• object Link
  A link referencing a REST API.
• Link to the targets under blackout.
• Example: { "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the targets under blackout."
        },
        {
            "example":{
                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
            }
        }
    ]
}

Nested Schema : Link

Type: object

A link referencing a REST API.

Show Source

• href: string
  Link URL

{
    "x-em-sdk-level":"emSDK",
    "description":"A link referencing a REST API.",
    "type":"object",
    "properties":{
        "href":{
            "description":"Link URL",
            "type":"string"
        }
    }
}

Nested Schema : Repeat

Type: object

Describes repetition of a blackout.

Show Source

• timeToEndRepeat: string
  End time of the repetition with timezone. Timestamps are with minute accuracy.

  Example: 2023-08-24T14:54-02:00

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

Match One Schema

Show Source

• object DaysOfYear
  List of days of year.
• object DaysOfMonth
  List of days of month in range 1-31 or -1 for last day of the month.
• object DaysOfWeek
  List of days of week.
• object EveryNWeeks
  Repeat every n weeks.
• object EveryNDays
  Repeat every n days.
• object EveryNHours
  Repeat every n hours.
• object EveryNMinutes
  Repeat every n minutes, minimal value is 2.

{
    "type":"object",
    "description":"Describes repetition of a blackout.",
    "properties":{
        "timeToEndRepeat":{
            "type":"string",
            "description":"End time of the repetition with timezone. Timestamps are with minute accuracy.",
            "example":"2023-08-24T14:54-02:00"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/DaysOfYear"
        },
        {
            "$ref":"#/components/schemas/DaysOfMonth"
        },
        {
            "$ref":"#/components/schemas/DaysOfWeek"
        },
        {
            "$ref":"#/components/schemas/EveryNWeeks"
        },
        {
            "$ref":"#/components/schemas/EveryNDays"
        },
        {
            "$ref":"#/components/schemas/EveryNHours"
        },
        {
            "$ref":"#/components/schemas/EveryNMinutes"
        }
    ]
}

Nested Schema : TimeToEnd

Type: object

An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).

Show Source

• timeToEnd(required): string
  An end time

  Example: 2023-08-23T14:54+01:00

{
    "type":"object",
    "required":[
        "timeToEnd"
    ],
    "description":"An object specifying an end time with timezone. Timestamps are with minute accuracy. Timezones can be given as offset (+01:00) or as zone (Europe/Berlin).",
    "properties":{
        "timeToEnd":{
            "type":"string",
            "description":"An end time",
            "example":"2023-08-23T14:54+01:00"
        }
    }
}

Nested Schema : Duration

Type: object

A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.

Show Source

• durationHours: integer
  Duration of the blackout in hours.

  Example: 2
• durationMinutes: integer
  Duration of the blackout in minutes.

  Example: 25

{
    "type":"object",
    "description":"A duration given in hours and minutes. At least one of durationHours and durationMinutes is required.",
    "properties":{
        "durationMinutes":{
            "type":"integer",
            "description":"Duration of the blackout in minutes.",
            "example":"25"
        },
        "durationHours":{
            "type":"integer",
            "description":"Duration of the blackout in hours.",
            "example":"2"
        }
    }
}

Nested Schema : DaysOfYear

Type: object

List of days of year.

Show Source

• daysOfYear: array daysOfYear
  List of days of the year.

{
    "type":"object",
    "description":"List of days of year.",
    "properties":{
        "daysOfYear":{
            "type":"array",
            "description":"List of days of the year.",
            "items":{
                "type":"object",
                "properties":{
                    "month":{
                        "type":"integer",
                        "description":"Month in range of 1-12."
                    },
                    "day":{
                        "type":"integer",
                        "description":"Day in range 1-31 or -1 for last day of the month."
                    }
                }
            }
        }
    }
}

Nested Schema : DaysOfMonth

Type: object

List of days of month in range 1-31 or -1 for last day of the month.

Show Source

• daysOfMonth: array daysOfMonth
  List of days of the month (1 based).

{
    "type":"object",
    "description":"List of days of month in range 1-31 or -1 for last day of the month.",
    "properties":{
        "daysOfMonth":{
            "type":"array",
            "description":"List of days of the month (1 based).",
            "items":{
                "type":"integer"
            },
            "example":[
                "1",
                "15"
            ]
        }
    }
}

Nested Schema : DaysOfWeek

Type: object

List of days of week.

Show Source

• daysOfWeek: array daysOfWeek
  List of days of week (localized short names).

{
    "type":"object",
    "description":"List of days of week.",
    "properties":{
        "daysOfWeek":{
            "type":"array",
            "description":"List of days of week (localized short names).",
            "items":{
                "type":"string",
                "enum":[
                    "MO",
                    "TU",
                    "WE",
                    "TH",
                    "FR",
                    "SA",
                    "SU"
                ]
            },
            "example":[
                "MO",
                "TH"
            ]
        }
    }
}

Nested Schema : EveryNWeeks

Type: object

Repeat every n weeks.

Show Source

• everyNWeeks: integer
  Repeat interval in weeks.

  Example: 2

{
    "type":"object",
    "description":"Repeat every n weeks.",
    "properties":{
        "everyNWeeks":{
            "type":"integer",
            "description":"Repeat interval in weeks.",
            "example":"2"
        }
    }
}

Nested Schema : EveryNDays

Type: object

Repeat every n days.

Show Source

• everyNDays: integer
  Repeat interval in days, minimal value is 1.

  Example: 5

{
    "type":"object",
    "description":"Repeat every n days.",
    "properties":{
        "everyNDays":{
            "type":"integer",
            "description":"Repeat interval in days, minimal value is 1.",
            "example":"5"
        }
    }
}

Nested Schema : EveryNHours

Type: object

Repeat every n hours.

Show Source

• everyNHours: integer
  Repeat interval in hours.

  Example: 2

{
    "type":"object",
    "description":"Repeat every n hours.",
    "properties":{
        "everyNHours":{
            "type":"integer",
            "description":"Repeat interval in hours.",
            "example":"2"
        }
    }
}

Nested Schema : EveryNMinutes

Type: object

Repeat every n minutes, minimal value is 2.

Show Source

• everyNMinutes: integer
  Repeat interval in minutes.

  Example: 45

{
    "type":"object",
    "description":"Repeat every n minutes, minimal value is 2.",
    "properties":{
        "everyNMinutes":{
            "type":"integer",
            "description":"Repeat interval in minutes.",
            "example":"45"
        }
    }
}

Nested Schema : daysOfYear

Type: array

List of days of the year.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"List of days of the year.",
    "items":{
        "type":"object",
        "properties":{
            "month":{
                "type":"integer",
                "description":"Month in range of 1-12."
            },
            "day":{
                "type":"integer",
                "description":"Day in range 1-31 or -1 for last day of the month."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• day: integer
  Day in range 1-31 or -1 for last day of the month.
• month: integer
  Month in range of 1-12.

{
    "type":"object",
    "properties":{
        "month":{
            "type":"integer",
            "description":"Month in range of 1-12."
        },
        "day":{
            "type":"integer",
            "description":"Day in range 1-31 or -1 for last day of the month."
        }
    }
}

Nested Schema : daysOfMonth

Type: array

List of days of the month (1 based).

Show Source

• Array of: integer

{
    "type":"array",
    "description":"List of days of the month (1 based).",
    "items":{
        "type":"integer"
    },
    "example":[
        "1",
        "15"
    ]
}

Example:

[
    "1",
    "15"
]

Nested Schema : daysOfWeek

Type: array

List of days of week (localized short names).

Show Source

• Array of: string
  Allowed Values: [ "MO", "TU", "WE", "TH", "FR", "SA", "SU" ]

{
    "type":"array",
    "description":"List of days of week (localized short names).",
    "items":{
        "type":"string",
        "enum":[
            "MO",
            "TU",
            "WE",
            "TH",
            "FR",
            "SA",
            "SU"
        ]
    },
    "example":[
        "MO",
        "TH"
    ]
}

Example:

[
    "MO",
    "TH"
]

Examples

Select an example Result - Create an immediate indefinite blackout Result - Create a one time blackout with start and end time Result - Create a one time blackout with start time and duration Result - Create a repeating blackout which repeats every 2 hours forever Result - Create a repeating blackout which repeats every 2 days and ends at specified time Result - Create a repeating blackout which repeats at specific days of the week Result - Create a repeating blackout which repeats at first and 15th day of the month Result - Create a repeating blackout which repeats at 15th and last day of the month Result - Create a repeating blackout which repeats at specific days of the year Result - Create a notification blackout but allow jobs to be run Result - Create a blackout on large system excluding all databases which are indirect members but include one specific db Result - Create a blackout on large system excluding specific indirect blackout members Result - Create a blackout on a host and request to fully blackout all targets on host

400 Response

One of the given parameters is invalid.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

401 Response

Client is not authenticated.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

409 Response

Not authorized or resource already exists.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

500 Response

Internal error serving the request.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

503 Response

Indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an error.

Show Source

• code: string
  Status code of the error.

  Example: IllegalArgument
• message: string
  A descriptive error message.

  Example: argument given is not supported

{
    "x-em-sdk-level":"emSDK",
    "description":"Response sent back in the case of an error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Status code of the error.",
            "example":"IllegalArgument"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message.",
            "example":"argument given is not supported"
        }
    }
}

Back to Top