getListSdwanServiceTrackerPayload - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"model","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/23e8b5f3-18c7-3987-af5b-8a2f827ee522","info":{"title":"Feature Profiles - SD-WAN Service","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Service Feature Profiles in SD-WAN Solution\n- Managing service-related (VPN Side) features including voice, security, and application optimization.\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"parcelId":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","$$ref":"#/components/schemas/CommonCommonDefs_uuidDef"},"parcelType":{"type":"string"},"createdBy":{"type":"string","description":"User who last created this.","readOnly":true},"createdOn":{"type":"integer","description":"Timestamp of creation","format":"int64","readOnly":true},"lastUpdatedBy":{"type":"string","description":"User who last updated this.","readOnly":true},"lastUpdatedOn":{"type":"integer","description":"Timestamp of last update","format":"int64","readOnly":true},"payload":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef","description":"Set the parcel name"},"description":{"description":"Set the parcel description","type":"string"},"data":{"if":{"anyOf":[{"properties":{"trackerName":{"properties":{"optionType":{"const":"global"}},"required":["optionType"]}},"required":["trackerName"]},{"properties":{"trackerType":{"properties":{"optionType":{"const":"global"}},"required":["optionType"]}},"required":["trackerType"]}]},"then":{"required":["trackerName","trackerType"]},"type":"object","properties":{"trackerName":{"description":"Tracker Name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"maxLength":128,"pattern":"^[^\u003c! ]+$","type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_trackerNameDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfTrackerNameOptionsDef"},"endpointApiUrl":{"description":"API url of endpoint","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maxLength":512,"minLength":0,"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_endpointApiUrlDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfEndpointApiUrlOptionsDef"},"endpointDnsName":{"description":"Endpoint DNS Name","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maxLength":63,"minLength":0,"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_endpointDnsDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfEndpointDnsNameOptionsDef"},"endpointIp":{"description":"Endpoint IP","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","format":"ipv4","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfEndpointIpOptionsDef"},"endpointTcpUdp":{"description":"Endpoint tcp/udp","type":"object","properties":{"protocol":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"description":"protocol type","type":"string","enum":["tcp","udp"],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_tcpUdpProtocolValueDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfTrackerTcpUdpProtocolOptionsDef"},"port":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":1,"maximum":65535,"type":"integer","$$ref":"#/components/schemas/CommonCommonDefs_portDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/CommonCommonDefs_oneOfPortOptionsDef"}}},"interval":{"description":"Interval","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maximum":600,"minimum":20,"type":"integer","default":60,"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_intervalDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":60,"minimum":60,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_defaultIntervalDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfIntervalOptionsDef"},"multiplier":{"description":"Multiplier","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maximum":10,"minimum":1,"type":"integer","default":3,"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_multiplierDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":3,"minimum":3,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_defaultMultiplierDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfMultiplierOptionsDef"},"threshold":{"description":"Threshold","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"maximum":1000,"minimum":100,"type":"integer","default":300,"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_thresholdDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":300,"minimum":300,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_defaultThresholdDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfThresholdOptionsDef"},"endpointTrackerType":{"description":"Endpoint Tracker Type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["static-route"],"type":"string","default":"static-route","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_endpointTrackerTypeDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"enum":["static-route"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_defaultEndpointTrackerTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfEndpointTrackerTypeOptionsDef"},"trackerType":{"description":"Tracker Type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["endpoint"],"type":"string","default":"endpoint","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_trackerTypeDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"enum":["endpoint"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_defaultTrackerTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_oneOfTrackerTypeOptionsDef"}},"additionalProperties":false}},"required":["name","data"],"x-metadata":{"supportedDeviceTypes":["asr","c1100","c8000be","csr1000v","ir8100","ir8340","isr","ISRv","ir1101"],"minVManageVersion":"20.17.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanServiceTrackerCommonRequest_SchemaPayload"}}}}},"$$ref":"#/components/schemas/getListSdwanServiceTrackerPayload","title":"getListSdwanServiceTrackerPayload"}}