Get Sdwan Service Tracker Parcel Schema By Schema Type - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Sdwan Service Tracker Parcel Schema By Schema Type","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":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Get a SDWAN Service Tracker Parcel Schema by Schema Type","operationId":"GetSdwanServiceTrackerParcelSchemaBySchemaType","parameters":[{"name":"schemaType","in":"query","required":true,"schema":{"type":"string","enum":["post","put"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"},"examples":{"post":{"value":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"trackerName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"maxLength":128,"pattern":"^[^\u003c! ]+$","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointApiUrl":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maxLength":512,"minLength":0,"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointDnsName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maxLength":63,"minLength":0,"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointIp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","format":"ipv4"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointTcpUdp":{"description":"Endpoint tcp/udp","type":"object","properties":{"protocol":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"description":"protocol type","type":"string","enum":["tcp","udp"]}},"required":["optionType","value"],"additionalProperties":false}]},"port":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":65535,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}}},"interval":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":600,"minimum":20,"type":"integer","default":60}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":60,"minimum":60,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"multiplier":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":10,"minimum":1,"type":"integer","default":3}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":3,"minimum":3,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"threshold":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":1000,"minimum":100,"type":"integer","default":300}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":300,"minimum":300,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointTrackerType":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["static-route"],"type":"string","default":"static-route"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["static-route"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"trackerType":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["endpoint"],"type":"string","default":"endpoint"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["endpoint"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"allOf":[{"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"]}}]}},"required":["name","data"],"x-metadata":{"supportedDeviceTypes":["asr","c1100","c8000be","csr1000v","ir8100","ir8340","isr","ISRv","ir1101"],"minVManageVersion":"20.17.1"},"additionalProperties":false},"$$ref":"#/components/examples/ProfileparcelSdwanServiceTrackerCommonRequest_ResolvedSchema"},"put":{"value":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128},"description":{"description":"Set the parcel description","type":"string"},"data":{"type":"object","properties":{"trackerName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minLength":1,"maxLength":128,"pattern":"^[^\u003c! ]+$","type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointApiUrl":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maxLength":512,"minLength":0,"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointDnsName":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maxLength":63,"minLength":0,"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointIp":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"type":"string","format":"ipv4"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointTcpUdp":{"description":"Endpoint tcp/udp","type":"object","properties":{"protocol":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"description":"protocol type","type":"string","enum":["tcp","udp"]}},"required":["optionType","value"],"additionalProperties":false}]},"port":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"minimum":1,"maximum":65535,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false}]}}},"interval":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":600,"minimum":20,"type":"integer","default":60}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":60,"minimum":60,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"multiplier":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":10,"minimum":1,"type":"integer","default":3}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":3,"minimum":3,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"threshold":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"maximum":1000,"minimum":100,"type":"integer","default":300}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"maximum":300,"minimum":300,"type":"integer"}},"required":["optionType","value"],"additionalProperties":false}]},"endpointTrackerType":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["static-route"],"type":"string","default":"static-route"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["static-route"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]},"trackerType":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["variable"]},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128},"default":{"minLength":1,"type":"string","maxLength":2048},"description":{"minLength":1,"type":"string","maxLength":128}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["global"]},"value":{"enum":["endpoint"],"type":"string","default":"endpoint"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["default"]},"value":{"enum":["endpoint"],"type":"string"}},"required":["optionType","value"],"additionalProperties":false}]}},"additionalProperties":false,"allOf":[{"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"]}}]}},"required":["name","data"],"x-metadata":{"supportedDeviceTypes":["asr","c1100","c8000be","csr1000v","ir8100","ir8340","isr","ISRv","ir1101"],"minVManageVersion":"20.17.1"},"additionalProperties":false},"$$ref":"#/components/examples/ProfileparcelSdwanServiceTrackerCommonRequest_ResolvedSchema"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e Service \u003e Tracker-read","method":"get","path":"/v1/feature-profile/sdwan/service/tracker/schema"}}