vps.maintenance_window

Manage VPS maintenance windows

Index

Path: GET /v7.0/vpses/{vps_id}/maintenance_windows
Description: List maintenance windows
Authentication required: yes
Scope: vps.maintenance_window#index
Aliases: list
Blocking: no

Input parameters

Layout: object
Namespace: maintenance_window

Parameter Type Required Details

from_id

From ID

Integer

no

List objects with IDs greater or lower than this value

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Validation error message: must be at least 0

limit

Limit

Integer

no

Number of objects to retrieve

Default: null

Validation rules
Rule	Details
Number	Must be a number after parameter type conversion. Minimum: `0` (inclusive). Maximum: `1000` (inclusive). Validation error message: must be between 0 and 1000

Output parameters

Layout: object_list
Namespace: maintenance_windows

Parameter	Type	Description
`weekday` Weekday	Integer
`is_open` Is_open	Boolean
`opens_at` Opens_at	Integer
`closes_at` Closes_at	Integer

Show

Path: GET /v7.0/vpses/{vps_id}/maintenance_windows/{maintenance_window_id}
Description: Show maintenance window
Authentication required: yes
Scope: vps.maintenance_window#show
Aliases: find
Blocking: no

Input parameters

No parameters.

Output parameters

Layout: object
Namespace: maintenance_window

Parameter	Type	Description
`weekday` Weekday	Integer
`is_open` Is_open	Boolean
`opens_at` Opens_at	Integer
`closes_at` Closes_at	Integer

Update

Path: PUT /v7.0/vpses/{vps_id}/maintenance_windows/{maintenance_window_id}
Description: Resize maintenance window
Authentication required: yes
Scope: vps.maintenance_window#update
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: maintenance_window

Parameter	Type	Required	Details
`is_open` Is_open	Boolean	no	Default: `null`
`opens_at` Opens_at	Integer	no	Default: `null`
`closes_at` Closes_at	Integer	no	Default: `null`

Output parameters

Layout: object
Namespace: maintenance_window

Parameter	Type	Description
`weekday` Weekday	Integer
`is_open` Is_open	Boolean
`opens_at` Opens_at	Integer
`closes_at` Closes_at	Integer

Update_all

Path: PUT /v7.0/vpses/{vps_id}/maintenance_windows
Description: Update maintenance windows for all week days at once
Authentication required: yes
Scope: vps.maintenance_window#update_all
Aliases
Blocking: no

Input parameters

Layout: object
Namespace: maintenance_window

Parameter	Type	Required	Details
`is_open` Is_open	Boolean	no	Default: `null`
`opens_at` Opens_at	Integer	no	Default: `null`
`closes_at` Closes_at	Integer	no	Default: `null`

Output parameters

Layout: object_list
Namespace: maintenance_windows

Parameter	Type	Description
`weekday` Weekday	Integer
`is_open` Is_open	Boolean
`opens_at` Opens_at	Integer
`closes_at` Closes_at	Integer