{"type":"api","title":"Updates the maintenance schedule information","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"updatesTheMaintenanceScheduleInformation","tags":["Devices"],"deprecated":false,"summary":"Updates the maintenance schedule information","description":"API to update the maintenance schedule for the network devices. \nThe `maintenanceSchedule` can be updated only if the `status` value is `UPCOMING` or `IN_PROGRESS`. User can exit `IN_PROGRESS` maintenance window by setting the `endTime` to -1. This will update the endTime to the current time and exit the maintenance window immediately. When exiting the maintenance window, only the endTime will be updated while other parameters remain read-only.\n","parameters":[{"name":"id","description":"Unique identifier for the maintenance schedule","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"A brief narrative describing the maintenance schedule."},"maintenanceSchedule":{"type":"object","properties":{"startTime":{"type":"number","description":"Start time indicates the beginning of the maintenance window in Unix epoch time in milliseconds."},"endTime":{"type":"number","description":"End time indicates the ending of the maintenance window in Unix epoch time in milliseconds."},"recurrence":{"type":"object","properties":{"interval":{"type":"integer","description":"Interval for recurrence in days. The interval must be longer than the duration of the schedules. The maximum allowed interval is 365 days."},"recurrenceEndTime":{"type":"number","description":"The end date for the recurrence in Unix epoch time in milliseconds. Recurrence end time should be greater than maintenance end date/time."}},"description":"Details about the recurrence of the maintenance schedule"}},"description":"Contains all the details necessary to define the maintenance window and its recurrence."},"networkDeviceIds":{"type":"array","items":{"type":"string"},"description":"List of network device ids. This field is applicable only during creation of schedules; for updates, it is read-only."}},"description":"","$$ref":"#/components/schemas/UpdatesTheMaintenanceScheduleInformationRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"string","description":"The UUID of the task"},"url":{"type":"string","description":"The path to the API endpoint to GET for information on the task"}},"description":"Contains information about a task to track the status of an asynchronous operation."},"version":{"type":"string","description":"The version of the response"}},"description":"","$$ref":"#/components/schemas/UpdatesTheMaintenanceScheduleInformationResponse"}}}},"202":{"description":"Accepted","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}}},"x-rapi-id":"8cb8-5ae3-4a2b-8a08","x-rapi-overview":"API to update the maintenance schedule for the network devices. \nThe `maintenanceSchedule` can be updated only if the `status` value is `UPCOMING` or `IN_PROGRESS`. User can exit `IN_PROGRESS` maintenance window by setting the `endTime` to -1. This will update the endTime to the current time and exit the maintenance window immediately. When exiting the maintenance window, only the endTime will be updated while other parameters remain read-only.\n","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/networkDeviceMaintenanceSchedules/${id}","x-rapi-publicPath":"/dna/intent/api/v1/networkDeviceMaintenanceSchedules/${id}","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"updatesTheMaintenanceScheduleInformation","method":"put","path":"/dna/intent/api/v1/networkDeviceMaintenanceSchedules/{id}"}}