{"type":"api","title":"Update Client Device","meta":{"id":"/apps/pubhub/media/edm-api-v2/a2a30bcc9ecab5281b65761ae61df7e0031d5691/f67a4e01-0023-334a-9a4a-7e606c2ef1a2","swagger":"2.0","info":{"contact":{"email":"devmgmt@cisco.com"},"description":"This is the IoT device management core service. The service is responsible for managing the lifecycle of various IoT gateways and endpoints deployed as part of the Field Area Networks","license":{"name":"Licensing is primarily subscription based. Call Andy now!","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"IoT Device Lifecycle Management","version":"4.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/edm/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"description":"This is the bearer Auth token.","in":"header","name":"Authorization","type":"apiKey"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"}}},"spec":{"consumes":["application/json"],"description":"Update client devices.\u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management\u003cbr /\u003e- Manage Devices","operationId":"updateClientDevice","parameters":[{"description":"The uuid of the tenant in whose context we are calling the api.","format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"description":"EID of the network device","in":"path","name":"device_eid","required":true,"type":"string"},{"description":"MAC address with dashes","in":"path","name":"mac_address_with_dashes","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"alertList":{"items":{"properties":{"alertThreshold":{"example":"","type":"string"},"alertType":{"example":"","type":"string"}},"type":"object","$$ref":"#/definitions/ClientAlertRequestVo"},"type":"array"},"clientName":{"example":"ios_ssh_server","type":"string"},"connectivityCheck":{"properties":{"lanCheck":{"example":true,"type":"boolean"},"portCheck":{"example":true,"type":"boolean"},"wanCheck":{"example":true,"type":"boolean"},"wanDestination":{"example":"","type":"string"},"wanPort":{"example":24,"format":"int32","type":"integer"},"wanType":{"enum":["TCP","PING"],"example":"TCP","type":"string"}},"type":"object","$$ref":"#/definitions/ClientConnectivityRequestVo"},"deviceType":{"example":"Other","type":"string"},"interface":{"example":"VirtualPortGroup0","type":"string"},"ip":{"example":"192.168.21.1","type":"string"},"mac":{"example":"44:b6:be:44:49:f0","type":"string"},"vlan":{"example":"","type":"string"}},"type":"object","$$ref":"#/definitions/ConnectedClientRequestVo"}}],"produces":["application/json"],"responses":{"200":{"description":"successful retrieval","schema":{"properties":{"actionurl":{"example":null,"type":"string"},"channel":{"example":null,"type":"string"},"clientName":{"example":"ios_ssh_server","type":"string"},"dataurl":{"example":"/resource/rest/api/v1/devices/IR1101-K9+FCW2510PGMW/clients/44-b6-be-44-49-f0","type":"string"},"deviceType":{"example":"Other","type":"string"},"excluded":{"example":null,"type":"boolean"},"interface":{"example":"VirtualPortGroup0","type":"string"},"ip":{"example":"192.168.21.1","type":"string"},"lan":{"example":null,"type":"boolean"},"lanStatus":{"example":null,"type":"boolean"},"lastHeard":{"example":null,"type":"string"},"mac":{"example":"44:b6:be:44:49:f0","type":"string"},"motionDetectionAlert":{"example":"DISABLED","type":"string"},"peopleCountExccededAlert":{"example":"DISABLED","type":"string"},"peopleCountThreshold":{"example":"","type":"string"},"port":{"example":"yes","type":"string"},"signalStrength":{"example":null,"type":"string"},"ssid":{"example":null,"type":"string"},"status":{"example":null,"type":"string"},"vehicleCountExccededAlert":{"example":"DISABLED","type":"string"},"vehicleCountThreshold":{"example":"","type":"string"},"vlan":{"example":"","type":"string"},"wan":{"example":null,"type":"boolean"},"wanDestination":{"example":null,"type":"string"},"wanStatus":{"example":null,"type":"boolean"}},"type":"object","$$ref":"#/definitions/ConnectedClientVo"}},"400":{"description":"Invalid input","schema":{"description":"Specifies the error that occurred during the request.","example":{"code":"10000","message":"Short message about the error","meta":"more information about that error"},"properties":{"code":{"description":"The error code that occurred in application level.","type":"number"},"message":{"description":"A user readable message that describes the error in details.","type":"string"},"meta":{"description":"Contains more information about the error message. For example when a validation error occurs, this field describes the fields that were invalid and the validation error that occurred. The content of this object can vary based on the type of error.\n","type":"object"}},"required":["code","message"],"type":"object","$$ref":"#/definitions/error"}},"401":{"description":"Unauthorized","schema":{"example":"Unauthorized","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"404":{"description":"Invalid group id supplied","schema":{"example":"Device not found by given device id","type":"string"}}},"summary":"Update client devices","tags":["devices"],"__originalOperationId":"updateClientDevice","security":[{"bearerAuth":[]}],"method":"put","path":"/devices/{device_eid}/clients/{mac_address_with_dashes}"}}