{"type":"api","title":"Get Network Device by Id","meta":{"id":"/apps/pubhub/media/sea-api/7c15e51e49c0ffa2ba78927684d875bb631dffa7/d5f79626-4df3-3cd0-aec3-6ecc5b860dd3","swagger":"2.0","info":{"description":"Deals with Remote Sessions, Access Management (Access Control Groups), and System Management (Network Devices and Assets) APIs","license":{"name":"Licensing is primarily subscription based.","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"Secure Equipment Access (SEA) Management APIs","version":"1.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/sramgmt/ext","schemes":["https"],"securityDefinitions":{"access_token":{"in":"header","name":"x-access-token","type":"apiKey"},"bearer_token":{"in":"header","name":"Authorization","type":"apiKey"}},"security":[{"access_token":[]},{"bearer_token":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"},"labelConfig":{"endpoint":"summary"}}},"spec":{"description":"Get Network Device details by Id\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA System Admin","operationId":"get_gateway_by_id","parameters":[{"format":"uuid","in":"path","name":"gateway_id","required":true,"type":"string"},{"format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Successful operation. Network Device received.","schema":{"type":"object","properties":{"capabilities":{"type":"string","example":"SpeedTestEnabled,SEAPlusEnabledALL,SEAPlusEnabledMP,PingAckEnabled"},"cli_commands_update":{"type":"string","example":"test cli commands"},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"description":{"type":"string","example":"test description"},"devices":{"type":"array","items":{"type":"object","properties":{"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.784"},"description":{"type":"string","example":"test description"},"device_id":{"type":"string","format":"uuid","example":"9da742db-b81f-4634-8521-b377b5d83e73"},"device_identifier":{"type":"string","description":"Any unique string recognizable by the customer (ex: device serial number).","example":"IE-3400-8P2S+FOC1408V0FJ"},"host":{"type":"string","format":"hostname","description":"Host can be a valid domain name (e.g. www.example.com), IP address (e.g. 1.1.1.1), or hostname (e.g. localhost)","example":"127.0.0.1"},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP (self)"},"probe_enabled_ping":{"type":"boolean","example":true},"probe_period":{"type":"integer","example":23},"probe_timeout":{"type":"integer","example":41},"status_health":{"type":"string","example":"UNKNOWN"},"status_health_last_updated":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.784"},"tenant_id":{"type":"string","format":"uuid","example":"fbbbc3a4-213a-4034-82a6-f5032c4d8221"},"type":{"type":"string","example":"IE3400"}},"$$ref":"#/definitions/response_common_device"}},"ext_controller_cross_launch_url":{"type":"string","format":"uri-reference","example":"https://1.1.1.1:1"},"gateway_id":{"type":"string","format":"uuid","example":"6e02e832-5538-47a7-aacf-24305b427e27"},"gateway_identifier":{"type":"string","description":"Any unique string recognizable by the customer (ex: gateway serial number). Will be used as username to IOx app.","example":"FCW1408P9S2TEMP"},"host":{"type":"string","format":"hostname","description":"Host can be a valid domain name (e.g. www.example.com), IP address (e.g. 1.1.1.1), or hostname (e.g. localhost)","example":"127.0.0.1"},"http_proxy":{"type":"object","properties":{"automatic_url":{"type":"string","format":"uri","example":"http(s)://domain\\username:password@ip:port"},"domain":{"type":"string","format":"hostname","example":"example.com"},"host":{"type":"string","format":"hostname","description":"Host can be a valid domain name (e.g. www.example.com), IP address (e.g. 1.1.1.1), or hostname (e.g. localhost)","example":"127.0.0.1"},"http_proxy_id":{"type":"string","format":"uuid","example":"e2d91efe-883d-4b73-8159-df353653f6bc"},"https_enabled":{"type":"boolean","default":true,"example":true},"password":{"type":"string","format":"password","example":"password"},"port":{"type":"integer","example":25},"username":{"type":"string","example":"username@cisco.com"}},"$$ref":"#/definitions/response_common_http_proxy"},"last_active":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"model":{"type":"string","enum":["IE3100","IE3105","IE3200","IE3300","IE3400","IR809","IR829","IR1101","IR1821","IR1831","IR1833","IR1835","IE9300","IE9310","IE9320","CAT9300","CAT9400"],"example":"IE3400"},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP"},"recovery_mode_expiration":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"secret":{"type":"string","example":"secret"},"sra_agent_app_container_version":{"type":"string","example":"2.0"},"sra_agent_app_phase":{"type":"string","enum":["STABLE","RELEASE","BETA"],"example":"STABLE"},"sra_agent_app_status":{"type":"string","description":"Status directly retrieved from App Manager (FD)","enum":["DEPLOYED","DEPLOYING","RUNNING","STARTING"],"example":"DEPLOYED"},"sra_agent_app_version":{"type":"string","example":"1.3"},"sra_agent_authorization_method":{"type":"string","example":"STATIC_SECRET"},"sra_agent_build_timestamp":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"sra_agent_build_version":{"type":"string","example":"release.2040-22-g1067698"},"sra_agent_installed_by":{"type":"string","enum":["APP_MGMT","CLI","DNAC","MANUAL","VMANAGE"],"example":"APP_MGMT"},"sra_agent_installed_by_display_name":{"type":"string","enum":["App Manager","CLI","DNAC","Manual Entry","WAN Manager"],"example":"App Manager"},"sra_agent_last_failed_auth_attempt":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"sra_agent_status":{"type":"string","description":"Available options: [Unsupported, Pending, Deploying, Installed, Enabled]","enum":["Pending","Unsupported","Deployed","Running","Failed"],"example":"Pending"},"sra_agent_status_details":{"type":"string","description":"Description for any errors during sra agent installation","example":"Unable to retrieve agent status"},"sra_agent_version":{"type":"string","description":"Version directly retrieved from App Manager (FD)","example":"0.84-stable-release-1067dc-(STABLE)"},"status":{"type":"string","description":"Available options: [Up, Down, Unknown]","enum":["Up","Down","Unknown"],"example":"Up"},"tenant_id":{"type":"string","format":"uuid","example":"54974c12-b930-4a03-94ad-08db3adfc260"},"vlans":{"type":"array","description":"Vlan is persisted on gateway create and passed to App Manager (FD) for app install","items":{"type":"object","properties":{"default_gateway_ip":{"type":"string","format":"ipv4","example":"192.168.1.1"},"dns_ip":{"type":"string","format":"ipv4","example":"8.8.8.8"},"ip":{"type":"string","format":"ipv4","example":"192.168.1.3"},"ip_type":{"type":"string","description":"Available options: [DYNAMIC/STATIC]","enum":["DYNAMIC","STATIC"],"example":"DYNAMIC"},"management_interface":{"type":"boolean","example":false},"subnet_mask":{"type":"integer","example":60},"vlan_id":{"type":"string","format":"uuid","example":"746eb4b4-ba6e-4f87-ab87-485fc6f2b0f8"},"vlan_identifier":{"type":"integer","example":29}},"$$ref":"#/definitions/response_common_vlan"}}},"$$ref":"#/definitions/response_get_gateway"}},"401":{"description":"Bad request","schema":{"example":"Authentication Token is invalid","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"404":{"description":"Network Device not found.","schema":{"properties":{"debug_message":{"items":{"type":"string"},"type":"array"},"error_code":{"type":"string"},"message":{"type":"string"}},"type":"object","$$ref":"#/definitions/response_error"}},"500":{"description":"Internal server error","schema":{"example":"Could not connect to server","type":"string"}}},"summary":"Get Network Device by Id","tags":["Network Devices"],"__originalOperationId":"get_gateway_by_id","security":[{"access_token":[]},{"bearer_token":[]}],"method":"get","path":"/gateways/{gateway_id}"}}