{"type":"api","title":"Get VM Life Cycle State","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":["Real-Time Monitoring - VM"],"description":"Get vm lifecycle state","operationId":"getVMLifeCycleState","parameters":[{"name":"deviceId","in":"query","description":"deviceId - Device IP","required":true,"schema":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$","type":"string","example":"169.254.10.10"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"VM lifecycle state":{"description":"VM lifecycle state","value":{"data":[{"vdevice-name":"172.16.255.15","vdevice-host-name":"vm5","deployment_name":"dep1","deployment_id":"SystemAdminTenantIdisrv1","name":"router1","state":"Active"}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"System-read,System-write,Routing-read,Routing-write","method":"get","path":"/device/vm/state"}}