REST deployment window series

A deployment window series is a series of special calendar events for allowing or preventing access to the specific environments.

GET /v1/deployment_window/series

Returns all deployment window series.

Filters

• aasm_state — String name of a valid status of object state 

  Note

  Valid status of object states are draft, pending, released, retired, and archived. By default, the aasm_state is Draft.

• name — String value for the deployment window series name
• behavior — String value for the deployment window series behavior (allow or prevent values)
• start_before — String value in the date and time format
• start_after — String value in the date and time format
• finish_before — String value in the date and time format
• finish_after — String value in the date and time format
• environments — Array of environment IDs associated with the deployment window series
• unarchived — Boolean value for filtering deployment window series by the unarchived status
• archived — Boolean value for filtering deployment window series by the archived status

Common attributes

• format — Be sure to include an accept header or add .xml or .json to the last path element
• token — Your API token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not Found — Occurs when no records are found

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

The following example shows filters:

GET /v1/deployment_window/series/[id]

Returns the deployment window series by ID.

Common attributes

• id — Unique numerical ID for a deployment window series
• format — Be sure to include an accept header or add .xml or .json  to the last path element
• token — Your API token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not found — Occurs when the record to show is not found

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

POST /v1/deployment_window/series

Creates a deployment window series from the posted data.

Required attributes

• name — String name of the environment (must be unique)
• behavior — String value for the deployment window series behavior (allow or prevent values).
• start_at — String value in the date and time format
• finish_at — String value in the date and format
• recurrent — Boolean value to set recurrence for the deployment window series

Optional attributes

• environments — Array of environment IDs to associate with the deployment window series

• aasm_state — String name of a valid status of object state

  Note

  For a POST operation, only the Draft state is allowed. By default, the aasm_state is Draft.

• duration_in_days — Integer value for the duration of the deployment window series in days.

  Note

  Enter a value for this attribute if you set the recurrent attribute to true.

• frequency — Hash value for the recurrent deployment window series that includes the following attributes:

  Note

  Enter values for this attribute if you set the recurrent attribute to true.

  • validations — Hash value for weekly and monthly recurrence type. Enter one of the following data:

    • For weekly recurrence type, enter week days in the following pattern: "day":[<day_of_week_1>, <day_of_week_2>].

      Note

      For week days, Monday is the first day of the week.

      For example, to set recurrence for every Monday and Thursday, enter the following data:

      "validations":{"day":[1,4]}

    • For monthly recurrence type, to set recurrence for dates of the month, enter dates of the month in the following pattern: "day_of_month":[<date_1>, <date_2>]
      
      For example,  to set recurrence 1st ,10th and 20th of the month, enter the following data:
      
      

      "validations":{"day_of_month":[1,10,20]}

    • For monthly recurrence type, to set recurrence for days of the week, enter dates of the month in the following pattern: "day_of_week":{<day_of_week_1>":[<week_1>,<week2>],<day_of_week_2>":[<week_1>,<week2>]}

      For example,  to set recurrence for Mondays of the first and third weeks and for Tuesdays of the second and fourth week, enter the following data:

      "day_of_week":{"1":[1,3],"2":[2,4]}}
  • rule_type — String value for daily, weekly, and monthly deployment window recurrence rules. Depending on the rule type, enter the following values:
    • IceCube::DailyRule
    • IceCube::WeeklyRule
    • IceCube::MonthlyRule
  • interval — Integer value for the deployment window event recurrence

Common attributes

• format — Be sure to include an accept header or add .xml or .json to the last path element
• token — Your API token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 422 Unprocessable entity — Occurs when validation fails; objects and errors are returned

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

PUT /v1/deployment_window/series/[id]

Updates an existing  deployment window series with values from the posted data.

Editable attributes

• aasm_state — String name of a valid status of object state

  Note

  Valid status of object states are draft, pending, released, retired, and archived. The aasm_state Archived can only be reached if the current aasm_state is Retired. If the current aasm_state is Archived, the only available state is Retired. By default, the aasm_state is Draft.

• name — String name of the environment (must be unique)
• behavior — String value for the deployment window behavior (allow or prevent values)
• start_at — String value in the date and time format
• finish_at — String value in the date and format
• recurrent — Boolean value to set recurrence for the deployment window

• environments — Array of environment IDs to associate with the deployment window

• duration_in_days — Integer value for the duration of the deployment window in days

  Note

  Enter a value for this attribute if you set the recurrent attribute to true.

• toggle_archive — Boolean value to toggle the archive status for the selected deployment window

  Note

  You can only toggle the archive status when the state is Archived or Retired.

• frequency — Hash value for recurrent deployment window series that includes the following attributes:

  Note

  Enter values for this attribute if you set the recurrent attribute to true.

  • validations — Hash value for weekly and monthly recurrence type. Enter one of the following data:

    • For weekly recurrence type, enter week days in the following pattern: "day":[<day_of_week_1>, <day_of_week_2>].

      Note

      For week days, Monday is the first day of the week.

      For example, to set recurrence for every Monday and Thursday, enter the following data:

      "validations":{"day":[1,4]}

    • For monthly recurrence type, to set recurrence for dates of the month,enter dates of the month in the following pattern: "day_of_month":[<date_1>, <date_2>]
      
      For example,  to set recurrence 1st ,10th and 20th of the month, enter the following data:
      
      

      "validations":{"day_of_month":[1,10,20]}

    • For monthly recurrence type, to set recurrence for days of the week, enter dates of the month in the following pattern: "day_of_week":{<day_of_week_1>":[<week_1>,<week2>],<day_of_week_2>":[<week_1>,<week2>]}

      For example,  to set recurrence for Mondays of the first and third weeks and for Tuesdays of the second and fourth week, enter the following data:

      "day_of_week":{"1":[1,3],"2":[2,4]}}
  • rule_type — String value for daily, weekly, and monthly deployment window recurrence rules. Depending on the rule type, enter the following values:
    • IceCube::DailyRule
    • IceCube::WeeklyRule
    • IceCube::MonthlyRule
  • interval — Integer value for the deployment window event recurrence

Common attributes

• format — Be sure to include an accept header or add .xml or .json to the last path element
• token — Your API token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not found — Occurs when the record to update is not found
• ERROR 422 Unprocessable entity — Occurs when validation fails; objects and errors are returned

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

DELETE /v1/deployment_window/series/[id]

Deletes the deployment window series.

Common attributes

• id — Unique numerical ID for record
• format — Be sure to include an accept header or add .xml or .json to the last path element
• token — Your API token for authentication

Errors caused

• ERROR 403 Forbidden — Occurs when the token is invalid
• ERROR 404 Not found — Occurs when no records to update are found
• ERROR 422 Unprocessable entity - Occurs when validation fails; objects and errors return
  
  

Examples

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

Sample output

The following JSON is sample output from GET /v1/deployment_windows/series/3:

The following XML is sample output from {{code language="none"}}
GET /v1/deployment_windows/series/3
{{/code}}:

Related topic

REST-API-commands

Managing-deployment-windows