{"type":"api","title":"Task Create","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Task Action - Create","operationId":"taskCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object"},"examples":{"Create Trace Start Task with empty Duration":{"description":"Create Trace Start Task with empty Duration","value":{"taskName":"auto-on","events":["sla-violation","qos-congestion"],"sites":["100","500"],"duration":""}},"Create Trace Start Task with Duration":{"description":"Create Trace Start Task with Duration","value":{"taskName":"auto-on","events":["sla-violation","qos-congestion"],"sites":["100","500"],"duration":"1440"}},"Create Trace Start Task without Duration":{"description":"Create Trace Start Task without Duration","value":{"taskName":"auto-on","events":["sla-violation","qos-congestion"],"sites":["100","500"]}},"Create Trace Start Task with Event Extensions":{"description":"Create Trace Start Task with Event Extensions","value":{"taskName":"auto_on","events":["qos-congestion","sla-violation","security-alert","wan-loss","tunnel-ipsec-anti-replay-drop"],"sites":["100","500"],"duration":1440,"qosCongestionExtensions":{"applications":["google-services"],"qosCongestionOccurrencesCount":2,"qosCongestionBurstInterval":60,"filters":["application-in-event"]},"slaViolationExtensions":{"applications":["rtp-video"],"slaViolationOccurrencesCount":2,"filters":["application-in-event"]},"securityAlertExtensions":{"firewallDropRate":10,"utdIpsAlertGid":1,"utdIpsAlertSid":49043,"utdFileSha":"131f95c51cc819465fa1797f6ccacf9d494aaaff46fa3eac73ae63ffbdfd8267","utdFileRetrospectiveSha":"131f95c51cc819465fa1797f6ccacf9d494aaaff46fa3eac73ae63ffbdfd8267","securityAlertSubEvent":["utd-ips-alert","utd-file-reputation-alert","utd-file-reputation-retrospective-alert","firewall-drop"],"filters":["source-ip-in-alert-event","destination-ip-in-alert-event"]},"wanLossExtensions":{"wanLossRate":30},"ipsecAntiReplayDropExtensions":{"ipsecAntiReplayDropRate":30}}},"Create Task with Time Scheduled Traces":{"description":"Create Task with Time Scheduled Traces","value":{"taskName":"auto_on","duration":1440,"taskTimeZone":"UTC+08:00","createdBy":"admin","timeScheduledTraceExtensions":{"traceSchedule":{"recurDaysList":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"traceActiveTimeList":[{"traceStartTime":"10:00","traceDuration":"60"},{"traceStartTime":"15:00","traceDuration":"60"}]},"tracePayload":{"source-site":"500","local-drop-rate-threshold":5,"wan-drop-rate-threshold":5,"device-list":[{"local-system-ip":"172.16.255.15","deviceId":"172.16.255.15","uuid":"C8K-646ad78f-fee8-41f1-be58-2f9c5b82f2cf","version":"17.18.01.0.214177"}],"vpn-list":["1","100"],"art-vis":"true","app-vis":"true","qos-mon":"true","te-mon":"true","source-site-version":"17.18","traceModel":"SDWAN_AUTO_ON"}}}},"Create Trace Start Task with Task Schedule Extensions":{"description":"Create Trace Start Task with Task Schedule Extensions","value":{"taskName":"auto_on","duration":1440,"events":["sla-violation","qos-congestion"],"sites":["500","600"],"taskTimeZone":"UTC+08:00","taskScheduleExtensions":{"recurDaysList":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"taskActiveTimeList":[{"taskActiveStartTime":"10:00","taskActiveDuration":"3"}]}}},"Create Task with Time Scheduled Traces and Task Schedule Extensions":{"description":"Create Task with Time Scheduled Traces and Task Schedule Extensions","value":{"taskName":"auto_on","duration":1440,"events":["sla-violation","qos-congestion"],"sites":["500","600"],"taskTimeZone":"UTC+08:00","createdBy":"admin","taskScheduleExtensions":{"recurDaysList":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"taskActiveTimeList":[{"taskActiveStartTime":"10:00","taskActiveDuration":"3"}]},"timeScheduledTraceExtensions":{"traceSchedule":{"recurDaysList":["Monday","Friday"],"traceActiveTimeList":[{"traceStartTime":"09:00","traceDuration":"60"}]},"tracePayload":{"source-site":"500","local-drop-rate-threshold":5,"wan-drop-rate-threshold":5,"device-list":[{"local-system-ip":"172.16.255.15","deviceId":"172.16.255.15","uuid":"C8K-646ad78f-fee8-41f1-be58-2f9c5b82f2cf","version":"17.18.01.0.214177"}],"vpn-list":["1","100"],"art-vis":"true","app-vis":"true","qos-mon":"true","te-mon":"true","source-site-version":"17.18","traceModel":"SDWAN_AUTO_ON"}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string"},"entry_time":{"type":"integer","format":"int32"},"expire-time":{"type":"integer","format":"int32"},"sites":{"type":"array","items":{"type":"string"}},"state":{"type":"string"},"taskId":{"type":"integer","format":"int32"},"taskName":{"type":"string"}},"description":"Auto on task create schema for POST response","$$ref":"#/components/schemas/TasksCreateResponsePayload"},"examples":{"Create task response":{"description":"Create task response","value":{"action":"success","sites":["100","500"],"taskId":3,"taskName":"auto_on","entry_time":1716795211822,"expire-time":1716881611822,"state":"active"}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write","method":"post","path":"/stream/device/nwpi/tasks/create"}}