Skip to main content

Create new Blackout Window

Select

SaaS
Customer Managed

Create a Blackout Window

Request Body
  • name string required

    Name of the blackout window to be created.

  • company object
  • id int32
  • name string
  • backupOperations string[]

    Possible values: [FULL, INCREMENTAL_AND_DIFFERENTIAL, SYNTHETIC_FULL, TRANSACTION_LOG, ALL_OPERATIONS]

    Refers to backup types to include in the blackout window

  • days string[]

    Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

    Days of the week when the blackout window will be in effect.

  • weeks string[]

    Possible values: [FIRST, SECOND, THIRD, FOURTH, LAST, EVERY]

    Refers to the weeks of the month that the blackout window will be in effect.

  • time object[]

    Refers to the time between which the blackout window will be in effect. It has to be provided in seconds

  • start int64

    the blackout window comes into effect at this point.

  • end int64

    the blackout window is no longer in effect from this point on.

  • betweenDates object
  • start int64

    the blackout window comes into effect at this point.

  • end int64

    the blackout window is no longer in effect from this point on.

  • doNotSubmitJob boolean

    Allows or Denies submitting a job when the blackout window is in effect. If set to false, the job is submitted and resumed once the blackout window ends.

Responses

Success


Schema
  • id int32
  • name string
POST /v4/blackoutwindow    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{
"name": "string",
"company": {
"id": 0,
"name": "string"
},
"backupOperations": [
"FULL"
],
"days": [
"SUNDAY"
],
"weeks": [
"FIRST"
],
"time": [
{
"start": 0,
"end": 0
}
],
"betweenDates": {
"start": 0,
"end": 0
},
"doNotSubmitJob": true
}
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/BlackoutWindow' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"name": "string",
"company": {
"id": 0,
"name": "string"
},
"backupOperations": [
"FULL"
],
"days": [
"SUNDAY"
],
"weeks": [
"FIRST"
],
"time": [
{
"start": 0,
"end": 0
}
],
"betweenDates": {
"start": 0,
"end": 0
},
"doNotSubmitJob": true
}'