{"type":"api","title":"Create Asset","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":{"consumes":["application/json"],"description":"Add a new Asset\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA System Admin","operationId":"create_device","parameters":[{"format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"connections":{"type":"array","items":{"type":"object","properties":{"advanced_parameters":{"type":"string","format":"json","description":"Advanced parameters JSON string (i.e. for guacamole: recording_path, create_recording_path, recording_exclude_mouse, recording_exclude_output, recording_include_keys, recording_name)","example":"{\"recording_path\": \"/example/to/path\", \"create_recording_path\": true}"},"application_cross_launch_params":{"type":"string","example":"-load \"Test Session\""},"application_cross_launch_path":{"type":"string","format":"uri","example":"\\filename.app"},"application_cross_launch_url":{"type":"string","format":"uri-reference","example":"https://1.1.1.1:1"},"associated_devices":{"type":"array","items":{"type":"object","properties":{"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)"}},"required":["name","host"],"$$ref":"#/definitions/input_associated_device"}},"clipboard_encoding":{"type":"string","description":"Available options: [ISO8859-1, UTF-8, UTF-16, CP1252]","enum":["ISO8859-1","UTF-8","UTF-16","CP1252"],"example":"UTF-8"},"color_depth":{"type":"integer","enum":[8,16,24,32],"example":8},"color_scheme":{"type":"string","description":"Available options: [black-white, gray-black, green-black, white-blacks]","enum":["black-white","gray-black","green-black","white-blacks"],"example":"black-white"},"description":{"type":"string","example":"test description"},"device_id":{"type":"string","format":"uuid","example":"6be299f4-3af1-49ec-96e9-28c49904c6ba"},"disable_download":{"type":"boolean","example":true},"disable_upload":{"type":"boolean","example":false},"domain":{"type":"string","format":"hostname","example":"example.com"},"drive_name":{"type":"string","example":"SRA Drive"},"enable_drive":{"type":"boolean","example":false},"font_size":{"type":"integer","example":13},"full_url":{"type":"string","format":"uri-reference","description":"Format follows as http(s)://\u003cdevice_id_host\u003e:\u003cremote_port\u003e/\u003clanding_url_path\u003e","example":"http://127.0.0.1:1/landing_url_path"},"group_id":{"type":"string","format":"uuid","example":"0cd9c62c-256c-46ba-9a25-90fc01cc62c9"},"idle_timeout":{"type":"integer","default":180,"minimum":60,"maximum":600,"example":180},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP (self) (SSH)"},"network_protocol":{"type":"string","description":"Available options: [ANY, ICMP, TCP, UDP]","enum":["ANY","ICMP","TCP","UDP"],"example":"ANY"},"password":{"type":"string","format":"password","example":"password"},"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_id":{"type":"string","format":"uuid","example":"cfc4f237-fcc1-45ca-9b42-adddf11ffb44"},"read_only":{"type":"boolean","example":true},"remote_port":{"type":"integer","example":61},"resize_method":{"type":"string","description":"Available options: [display-update, reconnect]","enum":["display-update","reconnect"],"example":"display-update"},"scrollback":{"type":"integer","example":90},"security":{"type":"string","description":"Available options: [any, nla, rdp]","enum":["any","nla","rdp"],"example":"any"},"username":{"type":"string","example":"username@cisco.com"}},"required":["device_id"],"$$ref":"#/definitions/input_post_connection"}},"description":{"type":"string","example":"test description"},"device_identifier":{"type":"string","description":"Any unique string recognizable by the customer (ex: device serial number).","example":"IE-3400-8P2S+FOC1408V0FJ"},"gateway_id":{"type":"string","format":"uuid","description":"Gateway that device will be connected to","example":"36118820-b81f-401c-b070-3ce87b484e11"},"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","minimum":0,"example":57},"probe_timeout":{"type":"integer","minimum":0,"example":44},"type":{"type":"string","example":"PLC"}},"$$ref":"#/definitions/input_post_device"}}],"produces":["application/json"],"responses":{"201":{"description":"Successful operation. Asset added.","schema":{"type":"object","properties":{"device_id":{"type":"string","format":"uuid","example":"e4295b7d-6bd8-4ac1-80d5-f041c8ce60e9"}},"$$ref":"#/definitions/response_device_id"}},"400":{"description":"Bad Request. Invalid input.","schema":{"properties":{"debug_message":{"items":{"type":"string"},"type":"array"},"error_code":{"type":"string"},"message":{"type":"string"}},"type":"object","$$ref":"#/definitions/response_error"}},"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"}},"500":{"description":"Internal server error","schema":{"example":"Could not connect to server","type":"string"}}},"summary":"Create Asset","tags":["Assets"],"__originalOperationId":"create_device","security":[{"access_token":[]},{"bearer_token":[]}],"method":"post","path":"/devices"}}