getSingleSdRoutingTransportTrackerPayload - 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/f75de7c3-5553-375b-b45f-644916a52d4b","info":{"title":"Feature Profiles - SD-Routing","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Feature Profiles in SD-Routing Solution\n- Supporting software-defined routing features and autonomous router management\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"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":{"properties":{"endpointTrackerType":{"properties":{"value":{"const":"interface"}}}}},"then":{"required":["interval","trackerName"]},"else":{"required":["icmpInterval","trackerName"]},"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/ProfileparcelSdRoutingTransportTrackerCommonRequest_trackerNameDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_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/ProfileparcelSdRoutingTransportTrackerCommonRequest_endpointApiUrlDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_oneOfEndpointApiUrlOptionsDef"},"endpointDnsName":{"description":"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/ProfileparcelSdRoutingTransportTrackerCommonRequest_endpointDnsDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_oneOfEndpointDnsNameOptionsDef"},"endpointIp":{"description":"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/ProfileparcelSdRoutingTransportTrackerCommonRequest_ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_oneOfEndpointIpOptionsDef"},"interval":{"description":"Probe 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/ProfileparcelSdRoutingTransportTrackerCommonRequest_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/ProfileparcelSdRoutingTransportTrackerCommonRequest_defaultIntervalDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_oneOfIntervalOptionsDef"},"icmpInterval":{"description":"Probe 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":1000,"minimum":2,"type":"integer","default":2,"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_icmpIntervalDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"maximum":2,"minimum":2,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_defaultIcmpIntervalDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_oneOfIcmpIntervalOptionsDef"},"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/ProfileparcelSdRoutingTransportTrackerCommonRequest_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/ProfileparcelSdRoutingTransportTrackerCommonRequest_defaultMultiplierDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_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/ProfileparcelSdRoutingTransportTrackerCommonRequest_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/ProfileparcelSdRoutingTransportTrackerCommonRequest_defaultThresholdDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_oneOfThresholdOptionsDef"},"endpointTrackerType":{"description":"Endpoint Tracker Type","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"metadata":{"enumDisplayName":[{"enumValue":"interface","displayValue":"http"},{"enumValue":"interface-icmp","displayValue":"icmp"}]},"enum":["interface","interface-icmp"],"type":"string","default":"interface","$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_endpointTrackerTypeDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"metadata":{"enumDisplayName":[{"enumValue":"interface","displayValue":"http"}]},"enum":["interface"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_defaultEndpointTrackerTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_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","object"],"type":"string","default":"endpoint","$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_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/ProfileparcelSdRoutingTransportTrackerCommonRequest_defaultTrackerTypeDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_oneOfTrackerTypeOptionsDef"}},"additionalProperties":false}},"required":["name","data"],"x-metadata":{"supportedDeviceTypes":["asr","c1100","c8000be","csr1000v","ir8100","ir8340","isr","ISRv","ir1101"],"minVManageVersion":"20.16.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdRoutingTransportTrackerCommonRequest_SchemaPayload"}},"$$ref":"#/components/schemas/getSingleSdRoutingTransportTrackerPayload","title":"getSingleSdRoutingTransportTrackerPayload"}}