Get Asset by Id - Secure Equipment Access (SEA) API

{"type":"api","title":"Get Asset 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 Asset details by Id\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA System Admin","operationId":"get_device_by_id","parameters":[{"format":"uuid","in":"path","name":"device_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. Asset received.","schema":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"object","properties":{"app_id":{"type":"string","format":"uuid","example":"f7636248-ff68-43ab-a817-bb5686a9423f"},"connection_name":{"type":"string","example":"IE-3400-8P2S+FOC1408V0FJ (self) (SSH)"},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.784"},"description":{"type":"string","example":"test description"},"group_count":{"type":"integer","example":85},"network_protocol":{"type":"string","description":"Available options: [ANY, ICMP, TCP, UDP]","enum":["ANY","ICMP","TCP","UDP"],"example":"ANY"},"protocol":{"type":"string","description":"Available options: [SSH, RDP, TELNET, VNC, WEB, SEA_PLUS]","enum":["SSH","RDP","TELNET","VNC","WEB","SEA_PLUS"],"example":"SSH"},"protocol_definition":{"type":"string","example":"Allow All Protocols"},"protocol_display_name":{"type":"string","description":"Available options: [SSH, RDP, Telnet, VNC, Web App, SEA Plus]","enum":["SSH","RDP","Telnet","VNC","Web App","SEA Plus"],"example":"SSH"},"remote_port":{"type":"integer","example":5},"tenant_id":{"type":"string","format":"uuid","example":"35a8b069-df2e-4aaf-b10e-5bf8943a3fa9"}},"$$ref":"#/definitions/response_common_application"}},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"description":{"type":"string","example":"test description"},"device_id":{"type":"string","format":"uuid","example":"ba93ac6d-7550-4518-abc8-c2f0245eeaa0"},"device_identifier":{"type":"string","description":"Any unique string recognizable by the customer (ex: device serial number).","example":"IE-3400-8P2S+FOC1408V0FJ"},"gateway":{"type":"object","properties":{"capabilities":{"type":"string","example":"SpeedTestEnabled,SEAPlusEnabledALL,SEAPlusEnabledMP,PingAckEnabled"},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.784"},"description":{"type":"string","example":"test description"},"ext_controller_cross_launch_url":{"type":"string","example":"https://1.1.1.1:1","format":"uri-reference"},"gateway_id":{"type":"string","format":"uuid","example":"3f20c9a3-a317-46bb-9425-9c43c54f0659"},"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"},"last_active":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.784"},"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"},"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":"Available options: [Lost Connection, others from App Mgmt response]","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_installable":{"type":"boolean","description":"To let users know if the gateway can currently install SEA agent app","example":true},"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_status":{"type":"string","description":"Available options: [Unsupported, Pending, Deployed, Running, Failed]","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"},"status":{"type":"string","description":"Available options: [Up, Down, Unknown]","enum":["Up","Down","Unknown"],"example":"Up"},"tenant_id":{"type":"string","format":"uuid","example":"71072a97-2951-474f-8d08-4a6da28d0c7a"}},"$$ref":"#/definitions/response_common_gateway"},"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":false},"probe_period":{"type":"integer","example":100},"probe_timeout":{"type":"integer","example":68},"status_health":{"type":"string","example":"UNKNOWN"},"status_health_last_updated":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"tenant_id":{"type":"string","format":"uuid","example":"8e35bb2e-adca-4162-bea3-e4e721d1b27b"},"type":{"type":"string","example":"IE3400"}},"$$ref":"#/definitions/response_get_device"}},"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":"Asset 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 Asset by Id","tags":["Assets"],"__originalOperationId":"get_device_by_id","security":[{"access_token":[]},{"bearer_token":[]}],"method":"get","path":"/devices/{device_id}"}}