{"openapi":"3.0.2","info":{"title":"GNS3 controller API","description":"This page describes the public controller API for GNS3","version":"v2"},"paths":{"/":{"get":{"tags":["Index"],"summary":"Root","operationId":"root__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/debug":{"get":{"tags":["Index"],"summary":"Debug","operationId":"debug_debug_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}},"deprecated":true}},"/static/web-ui/{file_path}":{"get":{"tags":["Index"],"summary":"Web Ui","description":"Web user interface","operationId":"web_ui_static_web_ui__file_path__get","parameters":[{"required":true,"schema":{"title":"File Path","type":"string"},"name":"file_path","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/shutdown":{"post":{"tags":["Controller"],"summary":"Shutdown","description":"Shutdown the local server","operationId":"shutdown_v2_shutdown_post","responses":{"204":{"description":"Successful Response"},"403":{"description":"Server shutdown not allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}}}},"/v2/version":{"get":{"tags":["Controller"],"summary":"Version","description":"Return the server version number.","operationId":"version_v2_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}}}},"post":{"tags":["Controller"],"summary":"Check Version","description":"Check if version is the same as the server.\n\n:param request:\n:param response:\n:return:","operationId":"check_version_v2_version_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}},"409":{"description":"Invalid version","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/iou_license":{"get":{"tags":["Controller"],"summary":"Get Iou License","description":"Return the IOU license settings","operationId":"get_iou_license_v2_iou_license_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IOULicense"}}}}}},"put":{"tags":["Controller"],"summary":"Update Iou License","description":"Update the IOU license settings.","operationId":"update_iou_license_v2_iou_license_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IOULicense"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IOULicense"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/statistics":{"get":{"tags":["Controller"],"summary":"Statistics","description":"Return server statistics.","operationId":"statistics_v2_statistics_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v2/appliances":{"get":{"tags":["Appliances"],"summary":"Get Appliances","description":"Return all appliances known by the controller.","operationId":"get_appliances_v2_appliances_get","parameters":[{"required":false,"schema":{"title":"Update","type":"boolean"},"name":
