{"type":"api","title":"Create Network Device","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 Network Device\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA System Admin","operationId":"create_gateway","parameters":[{"format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"description":"Specifies whether or not to begin the sea agent installation onto the network device","in":"query","name":"install_sra_agent","required":false,"type":"boolean"},{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"description":{"type":"string","example":"test description"},"ext_controller_cross_launch_url":{"type":"string","example":"https://1.1.1.1:1","format":"uri-reference"},"gateway_identifier":{"type":"string","description":"Any unique string recognizable by the customer (ex: gateway serial number). Will be used as username to connect IOx app over gRPC.","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"},"https_enabled":{"type":"boolean","default":true,"example":true},"password":{"type":"string","format":"password","example":"password"},"port":{"type":"integer","minimum":1,"maximum":65535,"example":32422},"username":{"type":"string","example":"username@cisco.com"}},"required":["host","port"],"$$ref":"#/definitions/input_http_proxy"},"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"},"secret":{"type":"string","example":"secret"},"sra_agent_installed_by":{"type":"string","enum":["APP_MGMT","CLI","DNAC","MANUAL","VMANAGE"],"example":"APP_MGMT"},"vlans":{"type":"array","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":true},"subnet_mask":{"type":"integer","minimum":0,"maximum":32,"example":5},"vlan_identifier":{"type":"integer","minimum":1,"maximum":4093,"example":3477}},"required":["ip_type","management_interface","vlan_identifier"],"$$ref":"#/definitions/input_vlan"}}},"required":["name"],"$$ref":"#/definitions/input_gateway"}}],"produces":["application/json"],"responses":{"201":{"description":"Successful operation. Network Device added.","schema":{"type":"object","properties":{"gateway_id":{"type":"string","format":"uuid","example":"b6b287f2-18c7-42ce-8346-c3fdd1d7b786"}},"$$ref":"#/definitions/response_gateway_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 Network Device","tags":["Network Devices"],"__originalOperationId":"create_gateway","security":[{"access_token":[]},{"bearer_token":[]}],"method":"post","path":"/gateways"}}