{"type":"api","title":"Get Topology Group Device Configuration Preview","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/8bb2440c-2dd0-310b-8b55-fbbf55ba4b5c","info":{"title":"UX 2.0 Configuration","description":"Configuration of UX 2.0 device, policy, and topology\n\nIncludes API operations for the following\n- Configuration Groups (SD-WAN and SD-Routing)\n- Policy Groups\n- Topology Groups\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Topology - Topology Group"],"description":"Get a preview of the configuration for a device","operationId":"getTopologyGroupDeviceConfigurationPreview","parameters":[{"name":"topologyGroupId","in":"path","description":"Topology Group Id","required":true,"schema":{"type":"string"}},{"name":"deviceId","in":"path","description":"Device Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"deactivateTopology":{"type":"boolean","description":"Preview vSmart configuration with Topology Group config removed"}},"required":[],"additionalProperties":false,"$$ref":"#/components/schemas/TopologygroupCommonPreviewPostRequest_SchemaPayload"},"examples":{"example_1":{"value":{"deactivateTopology":true},"$$ref":"#/components/examples/TopologygroupCommonPreviewPostRequest_example_1"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"existingConfig":{"type":"string"},"newConfig":{"type":"string"},"unsupportedParcels":{"type":"array","minItems":0,"items":{"type":"object"}}},"required":["existingConfig","newConfig"],"additionalProperties":false,"$$ref":"#/components/schemas/TopologygroupCommonPreviewPostResponse_SchemaPayload"},"examples":{"example_1":{"value":{"existingConfig":"old config","newConfig":"new config"},"$$ref":"#/components/examples/TopologygroupCommonPreviewPostResponse_example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Topology Group \u003e Device \u003e Activate-read","method":"post","path":"/v1/topology-group/{topologyGroupId}/device/{deviceId}/preview"}}