swagger

{"swagger":"2.0","info":{"version":"1.5.4.0","title":"Runecast Analyzer REST API"},"host":"89.185.239.124:44101","basePath":"/rc2","tags":[{"name":"v-1-info-controller","description":"V 1 Info Controller"},{"name":"v-1-results-controller","description":"V 1 Results Controller"}],"paths":{"/api/v1/licenses":{"get":{"tags":["Licensing"],"summary":"Get info about licenses","operationId":"getLicensingInfoUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LicensesDto"}},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/results":{"get":{"tags":["Results of Analysis"],"summary":"Get all issues (and their findings) reported in the last scan","operationId":"getAllResultsFromLastScanUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResultsWrapperDto"}},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/results/kbs/{kbId}":{"get":{"tags":["Results of Analysis"],"summary":"Get all findings reported in the last scan for the specified KB","operationId":"getAllResultsFromLastScanForKbUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"kbId","in":"path","description":"kbId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResultsWrapperDto"}},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/results/kbs/{kbId}/{vcUid}":{"get":{"tags":["Results of Analysis"],"summary":"Get all findings reported in the last scan for the specified KB and vCenter","operationId":"getAllResultsFromLastScanForKbAndVcUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"kbId","in":"path","description":"kbId","required":true,"type":"string"},{"name":"vcUid","in":"path","description":"vcUid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResultsDto"}},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/results/objects/{vcUid}":{"get":{"tags":["Results of Analysis"],"summary":"Get all issues (and their findings) reported in the last scan for the specified vCenter","operationId":"getAllResultsFromLastScanForVcUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"vcUid","in":"path","description":"vcUid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResultsDto"}},"400":{"description":"Invalid uid"},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/results/objects/{vcUid}/{moid}":{"get":{"tags":["Results of Analysis"],"summary":"Get all issues reported in the last scan that the specified object contributed to","operationId":"getAllResultsFromLastScanForVcAndObjectUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"vcUid","in":"path","description":"vcUid","required":true,"type":"string"},{"name":"moid","in":"path","description":"moid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResultsDto"}},"400":{"description":"Invalid uid"},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/scan/{vcUid}":{"post":{"tags":["vCenters"],"summary":"Trigger scan of the specified vCenter","operationId":"triggerScanForVCUsingPOST","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"vcUid","in":"path","description":"vcUid","required":true,"type":"string"}],"responses":{"400":{"description":"Invalid uid or the scan for this uid is in progress"},"202":{"description":"Accepted"},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/scan_status/{vcUid}":{"get":{"tags":["vCenters"],"summary":"Get scan status for the specified vCenter","operationId":"getScanStatusForVCUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"vcUid","in":"path","description":"vcUid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanStatusDto"}},"400":{"description":"Invalid uid"},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/syslog_config":{"get":{"tags":["Configuration"],"summary":"Get syslog configuration","operationId":"getSyslogConfigUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SyslogConfigsDto"}},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/syslog_config/{vcUid}":{"get":{"tags":["Configuration"],"summary":"Get syslog configuration for the specified vCenter","operationId":"getSyslogConfigForVcUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"parameters":[{"name":"vcUid","in":"path","description":"vcUid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SyslogConfigsDto"}},"400":{"description":"Invalid uid"},"503":{"description":"Initializing, try again in a few seconds"}}}},"/api/v1/vcenters":{"get":{"tags":["vCenters"],"summary":"Get info about vCenters","operationId":"listVcentersUsingGET","consumes":["application/json"],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VcentersDto"}},"503":{"description":"Initializing, try again in a few seconds"}}}}},"definitions":{"ResultsDto":{"type":"object","properties":{"issues":{"type":"array","items":{"$ref":"#/definitions/IssueDto"}},"scanStatus":{"$ref":"#/definitions/ScanStatusDto"},"uid":{"type":"string"}}},"ResultsWrapperDto":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ResultsDto"}}}},"ScanStatusDto":{"type":"object","properties":{"status":{"type":"string","enum":["NEVER_SCANNED","IN_PROGRESS","FINISHED_SUCCESSFULLY","FAILED","UNKNOWN"]},"timestamp":{"type":"string"}}},"ResultObjectDto":{"type":"object","properties":{"moid":{"type":"string"},"name":{"type":"string"},"resultValues":{"type":"array","items":{"$ref":"#/definitions/ResultValueDto"}},"type":{"type":"string"},"vcUid":{"type":"string"}}},"SyslogConfigsDto":{"type":"object","properties":{"pendingVcs":{"type":"array","items":{"type":"string"}},"syslogConfig":{"type":"array","items":{"$ref":"#/definitions/SyslogConfigDto"}}}},"VcenterDto":{"type":"object","properties":{"address":{"type":"string"},"port":{"type":"integer","format":"int32"},"uid":{"type":"string"}}},"LicensesDto":{"type":"object","properties":{"licensedHostCPUs":{"type":"integer","format":"int64"},"licensedHosts":{"type":"integer","format":"int64"},"licenses":{"type":"array","items":{"$ref":"#/definitions/LicenseDto"}},"unlicensedHostCPUs":{"type":"integer","format":"int64"},"unlicensedHosts":{"type":"integer","format":"int64"}}},"ResultValueDto":{"type":"object","properties":{"description":{"type":"string"},"value":{"type":"string"}}},"VcentersDto":{"type":"object","properties":{"vcenters":{"type":"array","items":{"$ref":"#/definitions/VcenterDto"}}}},"IssueDto":{"type":"object","properties":{"affectedObjects":{"type":"array","items":{"$ref":"#/definitions/ResultObjectDto"}},"affectedObjectsCount":{"type":"integer","format":"int32"},"affects":{"type":"string"},"annotation":{"type":"string"},"appliesTo":{"type":"string"},"id":{"type":"integer","format":"int64"},"severity":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}}},"SyslogConfigDto":{"type":"object","properties":{"hostStatuses":{"type":"array","items":{"$ref":"#/definitions/SyslogStatusDto"}},"lastRefreshed":{"type":"string"},"vcUid":{"type":"string"},"vmStatuses":{"type":"array","items":{"$ref":"#/definitions/SyslogStatusDto"}}}},"LicensedHostDto":{"type":"object","properties":{"hostCPUs":{"type":"integer","format":"int32"},"moid":{"type":"string"},"name":{"type":"string"},"vcUid":{"type":"string"}}},"SyslogStatusDto":{"type":"object","properties":{"moid":{"type":"string"},"name":{"type":"string"},"syslogConfigurable":{"type":"boolean"},"syslogConfigured":{"type":"boolean"}}},"LicenseDto":{"type":"object","properties":{"allowedCPUs":{"type":"integer","format":"int32"},"description":{"type":"string"},"guid":{"type":"string"},"licensedHosts":{"type":"array","items":{"$ref":"#/definitions/LicensedHostDto"}},"name":{"type":"string"},"usedCPUs":{"type":"integer","format":"int32"},"validUntil":{"type":"string"}}}}}