{"type":"api","title":"Get Net Interfaces","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":{"description":"Returns a map of device net-interfaces for single device eid.\u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management\u003cbr /\u003e- Troubleshoot Devices\u003cbr /\u003e- Manage Devices\u003cbr /\u003e- Manage Firmware Upgrades\u003cbr /\u003e- Manage Groups\u003cbr /\u003e- Manage Templates\u003cbr /\u003e- View Devices\u003cbr /\u003e- Delete_devices\u003cbr /\u003e- Deactivate Devices\u003cbr /\u003e- Request Device Deactivation/Deletion","operationId":"getNetInterfaces","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 for which device net-interfaces to return","in":"path","name":"device_eid","required":true,"type":"string"},{"description":"filter query for interfaces. Expected values - \"name:\u003cvalue\u003e operStatus:\u003cvalue\u003e\"","in":"query","name":"filter","required":false,"type":"string"},{"description":"Free form string used to perform search on name","in":"query","name":"search","required":false,"type":"string"},{"description":"Flat or hierarchical (grouped by expansion module) views of interfaces","enum":["MODULAR"],"in":"query","name":"view","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"successful retrieval","schema":{"properties":{"modularViewUrl":{"example":"/resource/rest/api/v1/devices/IR1101-K9+FCW2510PGMW/interfaces?view=modular","type":"string"},"results":{"properties":{"adminStatus":{"example":"up"},"encapsulation":{"example":"SCADA"},"ipAddress":{"example":["-"]},"ipV6AM":{"example":[]},"moduleDataName":{"example":"IR1101-K9 (Base Module)"},"moduleDataUrl":{"example":"/resource/rest/api/v1/devices/IR1101-K9+FCW2510PGMW/device_modules/FCW2510PGMW"},"name":{"example":"Async0/2/0"},"operStatus":{"example":"up"},"physAddress":{"example":"-"},"rxSpeed":{"example":"0"},"txDrops":{"example":"0.0"},"txSpeed":{"example":"0"}},"type":"object","$$ref":"#/definitions/InterfacesEntriesVo"},"total":{"example":1}},"required":["results"],"type":"object","$$ref":"#/definitions/InterfacesListVo"}},"400":{"description":"Bad Request if any service error related to fetching interfaces","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":"Not found","schema":{"example":"Device not found","type":"string"}}},"summary":"Find device net-interfaces by eid","tags":["devices"],"__originalOperationId":"getNetInterfaces","security":[{"bearerAuth":[]}],"method":"get","path":"/devices/{device_eid}/interfaces"}}