# Auto Upgrade

## Get

> Retrieve the Auto-upgrade settings of a session server with the specified ID.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AVD/HostPool/{id}/AutoUpgrade":{"get":{"tags":["0-Infrastructure/AVD/Host Pool//Auto-upgrade"],"summary":"Get","description":"Retrieve the Auto-upgrade settings of a session server with the specified ID.","operationId":"057486ad-b113-4914-a821-01c8fd3545e3","parameters":[{"name":"id","in":"path","description":"The ID of a session server for which to retrieve the Auto-upgrade settings.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/AutoUpgradeSettings"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"AutoUpgradeSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Enable auto-upgrade maintenance window</para>"},"startDateTime":{"type":"string","description":"<para type=\"description\">Start Date</para>","format":"date-time"},"drainModeDurationInSecs":{"type":"number","description":"<para type=\"description\">Drain mode duration</para>","format":"double"},"forceLogoffSessions":{"type":"boolean","description":"<para type=\"description\">Force logoff sessions at the end of the drain mode period</para>"},"repeat":{"$ref":"#/components/schemas/RepeatType"},"specificDays":{"$ref":"#/components/schemas/RepeatSpecificDays"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleMessage"},"description":"<para type=\"description\">Messages</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Auto-upgrade Settings</para>\r\n<para type=\"description\"></para>"},"RepeatType":{"enum":[["0 = Never","1 = EveryDay","2 = EveryWeek","3 = Every2Weeks","4 = EveryMonth","5 = EveryYear","6 = SpecificDays"]],"type":"string","description":"<para type=\"synopsis\">Repeat Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"RepeatSpecificDays":{"enum":[["0 = Never","1 = Sunday","2 = Monday","4 = Tuesday","8 = Wednesday","16 = Thursday","32 = Friday","64 = Saturday"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Repeat Specific Days</para>\r\n<para type=\"description\"></para>","format":"int32"},"ScheduleMessage":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Enabled</para>"},"messageTitle":{"type":"string","description":"<para type=\"description\">Message title</para>","nullable":true},"message":{"type":"string","description":"<para type=\"description\">Message</para>","nullable":true},"sendMsgSecs":{"type":"integer","description":"<para type=\"description\">Seconds before message is sent</para>","format":"int32"},"sendMsgWhen":{"$ref":"#/components/schemas/SendMsgWhen"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Schedule Message</para>\r\n<para type=\"description\"></para>"},"SendMsgWhen":{"enum":[["0 = Before","1 = After"]],"type":"string","description":"<para type=\"synopsis\">Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Update

> Update the Auto-upgrade settings of a session server with the specified ID.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AVD/HostPool/{id}/AutoUpgrade":{"put":{"tags":["0-Infrastructure/AVD/Host Pool//Auto-upgrade"],"summary":"Update","description":"Update the Auto-upgrade settings of a session server with the specified ID.","operationId":"7f192a90-64f1-46d7-97de-58882d751006","parameters":[{"name":"id","in":"path","description":"The ID of a session server for which to modify the Auto-upgrade settings.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Auto-upgrade settings.","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/SetAutoUpgrade"}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"SetAutoUpgrade":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Enable auto-upgrade maintenance window</para>","nullable":true},"startDateTime":{"type":"string","description":"<para type=\"description\">Start Date</para>","format":"date-time","nullable":true},"drainModeDurationInSecs":{"type":"number","description":"<para type=\"description\">Drain mode duration</para>","format":"double","nullable":true},"forceLogoffSessions":{"type":"boolean","description":"<para type=\"description\">Force logoff sessions at the end of the drain mode period</para>","nullable":true},"repeat":{"$ref":"#/components/schemas/RepeatType"},"specificDays":{"$ref":"#/components/schemas/RepeatSpecificDays"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Modify the Auto-upgrade settings</para>\r\n<para type=\"description\"></para>"},"RepeatType":{"enum":[["0 = Never","1 = EveryDay","2 = EveryWeek","3 = Every2Weeks","4 = EveryMonth","5 = EveryYear","6 = SpecificDays"]],"type":"string","description":"<para type=\"synopsis\">Repeat Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"RepeatSpecificDays":{"enum":[["0 = Never","1 = Sunday","2 = Monday","4 = Tuesday","8 = Wednesday","16 = Thursday","32 = Friday","64 = Saturday"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Repeat Specific Days</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```