Create a Blackout Window

Select

SaaS

Customer Managed

Create a Blackout Window

application/json

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

• allDays object[]

  Days of the week along with the time on which the black out window will be in effect.

  days string[]

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

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

  time 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.

• 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.

• 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

• 200
• 400
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• id int32
• name string

{
  "id": 0,
  "name": "string"
}

Bad Request

Internal Server Error

POST /v5/blackoutwindow    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

{
  "name": "string",
  "company": {
    "id": 0,
    "name": "string"
  },
  "backupOperations": [
    "FULL"
  ],
  "allDays": [
    {
      "days": [
        "SUNDAY"
      ],
      "time": {
        "start": 0,
        "end": 0
      }
    }
  ],
  "weeks": [
    "FIRST"
  ],
  "betweenDates": {
    "start": 0,
    "end": 0
  },
  "doNotSubmitJob": true
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V5/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"
  ],
  "allDays": [
    {
      "days": [
        "SUNDAY"
      ],
      "time": {
        "start": 0,
        "end": 0
      }
    }
  ],
  "weeks": [
    "FIRST"
  ],
  "betweenDates": {
    "start": 0,
    "end": 0
  },
  "doNotSubmitJob": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V5/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"
  ],
  "allDays": [
    {
      "days": [
        "SUNDAY"
      ],
      "time": {
        "start": 0,
        "end": 0
      }
    }
  ],
  "weeks": [
    "FIRST"
  ],
  "betweenDates": {
    "start": 0,
    "end": 0
  },
  "doNotSubmitJob": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V5/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"
  ],
  "allDays": [
    {
      "days": [
        "SUNDAY"
      ],
      "time": {
        "start": 0,
        "end": 0
      }
    }
  ],
  "weeks": [
    "FIRST"
  ],
  "betweenDates": {
    "start": 0,
    "end": 0
  },
  "doNotSubmitJob": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V5/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"
  ],
  "allDays": [
    {
      "days": [
        "SUNDAY"
      ],
      "time": {
        "start": 0,
        "end": 0
      }
    }
  ],
  "weeks": [
    "FIRST"
  ],
  "betweenDates": {
    "start": 0,
    "end": 0
  },
  "doNotSubmitJob": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V5/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"
  ],
  "allDays": [
    {
      "days": [
        "SUNDAY"
      ],
      "time": {
        "start": 0,
        "end": 0
      }
    }
  ],
  "weeks": [
    "FIRST"
  ],
  "betweenDates": {
    "start": 0,
    "end": 0
  },
  "doNotSubmitJob": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V5/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"
  ],
  "allDays": [
    {
      "days": [
        "SUNDAY"
      ],
      "time": {
        "start": 0,
        "end": 0
      }
    }
  ],
  "weeks": [
    "FIRST"
  ],
  "betweenDates": {
    "start": 0,
    "end": 0
  },
  "doNotSubmitJob": true
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V5/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"
  ],
  "allDays": [
    {
      "days": [
        "SUNDAY"
      ],
      "time": {
        "start": 0,
        "end": 0
      }
    }
  ],
  "weeks": [
    "FIRST"
  ],
  "betweenDates": {
    "start": 0,
    "end": 0
  },
  "doNotSubmitJob": true
}'