swagger.json

{"swagger":"2.0","info":{"title":"Vulcan API","description":"Public API for Vulcan Vulnerability Scan Engine","version":"1.1.3"},"host":"www.vulcan.example.com","basePath":"/api/v1","schemes":["https"],"consumes":["application/json"],"produces":["application/json","application/xml","application/gob","application/x-gob"],"paths":{"/healthcheck":{"get":{"tags":["healthcheck"],"summary":"show healthcheck","description":"A simple HTTP healthcheck.","operationId":"healthcheck#show","produces":["healthcheck"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Healthcheck"}}},"schemes":["https"]}},"/issues/":{"get":{"tags":["issues"],"summary":"list issues","description":"List all the issues.","operationId":"issues#list","produces":["issues_list"],"parameters":[{"name":"page","in":"query","description":"Requested page","required":false,"type":"number"},{"name":"size","in":"query","description":"Requested page size","required":false,"type":"number"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Issues_list"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/jobs/{job_id}":{"get":{"tags":["jobs"],"summary":"show jobs","description":"Describes job status and results. The possible values for the status are:\n\t- 'PENDING': The job has been noted and is pending to be processed\n\t- 'RUNNING': The job is on execution\n\t- 'DONE': The job has finished, either successfully or unsuccesfully. Result.error needs to be processed to determine it\n\nThe results field indicates if there was an error during the execution of the job, and otherwise can return data from the job execution","operationId":"jobs#show","produces":["job"],"parameters":[{"name":"job_id","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Job"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/profile":{"get":{"tags":["user"],"summary":"profile user","description":"Show profile information for the current authenticated user based on the key used to make the request.","operationId":"user#profile","produces":["user"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/User"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/stats/assets":{"get":{"tags":["global-stats"],"summary":"assets global-stats","description":"Get global assets per severity statistics.","operationId":"global-stats#assets","produces":["statsassets"],"parameters":[{"name":"identifiers","in":"query","description":"A comma separated list of asset identifiers","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"tags","in":"query","description":"Comma separated list of team tags to filter by. Only admin and observer users are allowed to set this field.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Statsassets"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/stats/exposure":{"get":{"tags":["global-stats"],"summary":"exposure global-stats","description":"Get global exposure statistics. This metric takes into account the exposure across all lifecycle of vulnerabilities.","operationId":"global-stats#exposure","produces":["exposure"],"parameters":[{"name":"atDate","in":"query","description":"Specific date to get statistics at","required":false,"type":"string"},{"name":"maxScore","in":"query","description":"Maximum issues score filter","required":false,"type":"number"},{"name":"minScore","in":"query","description":"Minimum issues score filter","required":false,"type":"number"},{"name":"tags","in":"query","description":"Comma separated list of team tags to filter by. Only admin and observer users are allowed to set this field.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Exposure"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/stats/exposure/current":{"get":{"tags":["global-stats"],"summary":"current exposure global-stats","description":"Get global current exposure statistics. This metric takes into account only the exposure for open vulnerabilities since the last time they were detected.","operationId":"global-stats#current exposure","produces":["current_exposure"],"parameters":[{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxScore","in":"query","description":"Maximum issues score filter","required":false,"type":"number"},{"name":"minScore","in":"query","description":"Minimum issues score filter","required":false,"type":"number"},{"name":"tags","in":"query","description":"Comma separated list of team tags to filter by. Only admin and observer users are allowed to set this field.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Current_exposure"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/stats/fixed":{"get":{"tags":["global-stats"],"summary":"fixed global-stats","description":"Get global fixed issues statistics.","operationId":"global-stats#fixed","produces":["statsfixed"],"parameters":[{"name":"atDate","in":"query","description":"Specific date to get statistics at (incompatible and preferential to min and max date params)","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of asset identifiers","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Maximum date to filter statistics by","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Minimum date to filter statistics by","required":false,"type":"string"},{"name":"tags","in":"query","description":"Comma separated list of team tags to filter by. Only admin and observer users are allowed to set this field.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Statsfixed"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/stats/mttr":{"get":{"tags":["global-stats"],"summary":"mttr global-stats","description":"Get global MTTR statistics.","operationId":"global-stats#mttr","produces":["mttr"],"parameters":[{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Maximum date to filter statistics by","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Minimum date to filter statistics by","required":false,"type":"string"},{"name":"tags","in":"query","description":"Comma separated list of team tags to filter by. Only admin and observer users are allowed to set this field.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mttr"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/stats/open":{"get":{"tags":["global-stats"],"summary":"open global-stats","description":"Get global open issues statistics.","operationId":"global-stats#open","produces":["statsopen"],"parameters":[{"name":"atDate","in":"query","description":"Specific date to get statistics at (incompatible and preferential to min and max date params)","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of asset identifiers","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Maximum date to filter statistics by","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Minimum date to filter statistics by","required":false,"type":"string"},{"name":"tags","in":"query","description":"Comma separated list of team tags to filter by. Only admin and observer users are allowed to set this field.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Statsopen"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams":{"get":{"tags":["teams"],"summary":"list teams","description":"List all teams in Vulcan.","operationId":"teams#list","produces":["team; type=collection"],"parameters":[{"name":"tag","in":"query","description":"Team tag","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeamCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["teams"],"summary":"create teams","description":"Create a new team.","operationId":"teams#create","produces":["team"],"parameters":[{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/TeamPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Team"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}":{"get":{"tags":["teams"],"summary":"show teams","description":"Show information about a team.","operationId":"teams#show","produces":["team"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Team"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["teams"],"summary":"delete teams","description":"Delete a team.","operationId":"teams#delete","parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["teams"],"summary":"update teams","description":"Update information about a team.","operationId":"teams#update","produces":["team"],"parameters":[{"name":"team_id","in":"path","description":"team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/TeamUpdatePayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Team"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/assets":{"get":{"tags":["assets"],"summary":"list assets","description":"List all assets from a team.","operationId":"assets#list","produces":["listassetentry; type=collection"],"parameters":[{"name":"identifier","in":"query","description":"Identifier","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ListassetentryCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["assets"],"summary":"create assets","description":"Creates assets in bulk mode.\n\t\t\tThis operation accepts an array of assets, an optional array of group identifiers, an optional map of annotations, and returns an array of successfully created assets.\n\t\t\tIf no groups are specified, assets will be added to the team's Default group.\n\t\t\tIf one of the specified assets already exists for the team but is currently not associated with the requested groups, the association is created.\n\t\t\tIf for any reason, the creation of an asset fails, an error message will be returned referencing the failed asset and the entire operation will be rolled back.\n\t\t\t---\n\t\t\tValid asset types:\n\t\t\t- AWSAccount\n\t\t\t- DomainName\n\t\t\t- Hostname\n\t\t\t- IP\n\t\t\t- IPRange\n\t\t\t- DockerImage\n\t\t\t- WebAddress\n\t\t\t- GitRepository\n\t\t\t- GCPProject\n\t\t\t---\n\t\t\tIf the asset type is informed, then Vulcan will use that value to create the new asset.\n\t\t\tOtherwise, Vulcan will try to automatically discover the asset type.\n\t\t\tNotice that this may result in Vulcan creating more than one asset.\n\t\t\tFor instance, an user trying to create an asset for \"vulcan.example.com\", without specifying the asset type, will end up with two assets created:\n\t\t\t- vulcan.example.com (DomainName) and\n\t\t\t- vulcan.example.com (Hostname).","operationId":"assets#create","produces":["asset; type=collection"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/CreateAssetPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/AssetCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/assets/discovery":{"put":{"tags":["assets"],"summary":"discover assets","description":"This endpoint receives a list of assets with embedded\nasset annotations, and the group name where to be added. It should be used by\nthird-party asset discovery services to onboard the discovered assets into\nVulcan. The provided list of assets will overwrite the assets previously\npresent in the group, in a way that:\n  - Assets that do not exist in the team will be created and associated to the\n  group\n  - Assets that were already existing in the team but not associated to the\n  group will be associated\n  - Existing assets where the scannable field or the annotations are different\n  will be updated accordingly\n  - Assets that were associated to the group and now are not present in the\n  provided list will be de-associated from the group if they belong to any\n  other group, or deleted otherwise\nBecause of the latency of this operation the endpoint is asynchronous. It\nreturns a 202-Accepted HTTP response with the Job information in the response\nbody.\n\nThe discovery group name must end with '-discovered-assets' to not mess with\nmanually managed asset groups. Also the first part of the name should identify\nthe discovery service using the endpoint, for example:\nserviceX-discovered-assets.\nAlso be aware that the provided annotations may differ from the ones that will\nbe stored, because they will include a prefix to not mess with any other\nannotations already present in the asset.\n\nDuplicated assets (same identifier and type) in the payload are ignored if all\ntheir attributes are matching. Otherwise they produce an error and the job is\naborted.","operationId":"assets#discover","produces":["job"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/DiscoveredAssetsPayload"}}],"responses":{"202":{"description":"Created: All assets were created with success.","schema":{"$ref":"#/definitions/Job"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/assets/multistatus":{"post":{"tags":["assets"],"summary":"createMultiStatus assets","description":"Creates assets in bulk mode (MultiStatus).\n\t\t\tThis operation is similar to the \"Create Assets in Bulk Mode\", with 2 main differences:\n\t\t\t- This endpoint is not atomic. Each asset creation request will succeed or fail indenpendently of the other requests.\n\t\t\t- This endpoint will return an array of AssetResponse in the following way:\n\t\t\t\t· For each asset with specified type, returns an AssetResponse indicating the success or failure for its creation.\n\t\t\t\t· For each asset with no type specified and successfully created, returns one AssetResponse for each auto detected asset.\n\t\t\t\t· For each asset detected from the ones with no type indicated which their creation produced an error, returns one AssetResponse indicating the failure for its creation specifying its detected type.\n\t\t\tIn the case of all assets being successfully created, this endpoint will return status code 201-Created. \n\t\t\tOtherwise, it will return a 207-MultiStatus code, indicating that at least one of the requested operations failed.\t\n\t\t","operationId":"assets#createMultiStatus","produces":["assetresponse; type=collection"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/CreateAssetPayload"}}],"responses":{"201":{"description":"Created: All assets were created with success.","schema":{"$ref":"#/definitions/AssetresponseCollection"}},"207":{"description":"Multiple Status: At least one of the assets failed to be created.","schema":{"$ref":"#/definitions/AssetresponseCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/assets/{asset_id}":{"get":{"tags":["assets"],"summary":"show assets","description":"Describe an asset.","operationId":"assets#show","produces":["asset"],"parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Asset"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["assets"],"summary":"delete assets","description":"Delete an asset.","operationId":"assets#delete","parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["assets"],"summary":"update assets","description":"Update an asset.\n\t\tAsset type and identifier can not be modified.","operationId":"assets#update","produces":["asset"],"parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/AssetUpdatePayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Asset"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/assets/{asset_id}/annotations":{"get":{"tags":["asset-annotations"],"summary":"list asset-annotations","description":"List annotations of a given asset.","operationId":"asset-annotations#list","produces":["assetannotations_response"],"parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Assetannotations_response"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"put":{"tags":["asset-annotations"],"summary":"put asset-annotations","description":"Override all annotations with a new list","operationId":"asset-annotations#put","produces":["assetannotations_response"],"parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/AssetAnnotationRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Assetannotations_response"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["asset-annotations"],"summary":"create asset-annotations","description":"Create one or more annotation for a given asset.","operationId":"asset-annotations#create","produces":["assetannotations_response"],"parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/AssetAnnotationRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Assetannotations_response"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["asset-annotations"],"summary":"delete asset-annotations","description":"Delete one or more annotation for a given asset.","operationId":"asset-annotations#delete","parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/AssetAnnotationDeleteRequest"}}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["asset-annotations"],"summary":"update asset-annotations","description":"Update one or more annotation for a given asset.","operationId":"asset-annotations#update","produces":["assetannotations_response"],"parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/AssetAnnotationRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Assetannotations_response"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings":{"get":{"tags":["findings"],"summary":"list findings findings","description":"List all findings from a team.","operationId":"findings#list findings","produces":["findings_list"],"parameters":[{"name":"atDate","in":"query","description":"Allows to get findings list at a specific date (incompatible and preferential to min and max date params)","required":false,"type":"string"},{"name":"identifier","in":"query","description":"Allows to get findings list for a specific asset identifier","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of identifiers","required":false,"type":"string"},{"name":"issueID","in":"query","description":"Issue ID (Vulnerability DB)","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Allows to get findings list until a specific date","required":false,"type":"string"},{"name":"maxScore","in":"query","description":"Findings maximum score","required":false,"type":"number"},{"name":"minDate","in":"query","description":"Allows to get findings list from a specific date","required":false,"type":"string"},{"name":"minScore","in":"query","description":"Findings minimum score","required":false,"type":"number"},{"name":"page","in":"query","description":"Requested page","required":false,"type":"number"},{"name":"size","in":"query","description":"Requested page size","required":false,"type":"number"},{"name":"sortBy","in":"query","description":"Sorting criteria. Supported fields: score, -score (for descending order)","required":false,"type":"string"},{"name":"status","in":"query","description":"Findings Status","required":false,"type":"string"},{"name":"targetID","in":"query","description":"Target ID (Vulnerability DB)","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Findings_list"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings/issues":{"get":{"tags":["findings"],"summary":"list findings issues findings","description":"List number of findings and max score per issue.","operationId":"findings#list findings issues","produces":["findings_issues_list"],"parameters":[{"name":"atDate","in":"query","description":"Allows to get issues list at a specific date","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of identifiers","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Allows to get findings list until a specific date","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Allows to get findings list from a specific date","required":false,"type":"string"},{"name":"page","in":"query","description":"Requested page","required":false,"type":"number"},{"name":"size","in":"query","description":"Requested page size","required":false,"type":"number"},{"name":"sortBy","in":"query","description":"Sorting criteria. Supported fields: max_score, targets_count (use - for descending order. E.g.: -max_score)","required":false,"type":"string"},{"name":"status","in":"query","description":"Findings Status","required":false,"type":"string"},{"name":"targetID","in":"query","description":"Target ID (Vulnerability DB)","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Findings_issues_list"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings/issues/{issue_id}":{"get":{"tags":["findings"],"summary":"Find findings from a Issue findings","description":"Find all findings from a team and issue.","operationId":"findings#Find findings from a Issue","produces":["findings_list"],"parameters":[{"name":"atDate","in":"query","description":"Allows to get findings list at a specific date (incompatible and preferential to min and max date params)","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of identifiers","required":false,"type":"string"},{"name":"issue_id","in":"path","description":"Issue ID","required":true,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Allows to get findings list until a specific date","required":false,"type":"string"},{"name":"maxScore","in":"query","description":"Findings maximum score","required":false,"type":"number"},{"name":"minDate","in":"query","description":"Allows to get findings list from a specific date","required":false,"type":"string"},{"name":"minScore","in":"query","description":"Findings minimum score","required":false,"type":"number"},{"name":"page","in":"query","description":"Requested page","required":false,"type":"number"},{"name":"size","in":"query","description":"Requested page size","required":false,"type":"number"},{"name":"sortBy","in":"query","description":"Sorting criteria. Supported fields: score, -score (for descending order)","required":false,"type":"string"},{"name":"status","in":"query","description":"Findings Status","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Findings_list"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings/labels":{"get":{"tags":["findings"],"summary":"List findings labels findings","description":"List all findings labels.","operationId":"findings#List findings labels","produces":["findings_labels"],"parameters":[{"name":"atDate","in":"query","description":"Allows to get findings list at a specific date (incompatible and preferential to min and max date params)","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of identifiers","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Allows to get findings list until a specific date","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Allows to get findings list from a specific date","required":false,"type":"string"},{"name":"status","in":"query","description":"Findings status","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Findings_labels"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings/targets":{"get":{"tags":["findings"],"summary":"list findings targets findings","description":"List number of findings and max score per target.","operationId":"findings#list findings targets","produces":["findings_targets_list"],"parameters":[{"name":"atDate","in":"query","description":"Allows to get targets list at a specific date","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of identifiers","required":false,"type":"string"},{"name":"issueID","in":"query","description":"Issue ID (Vulnerability DB)","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Allows to get findings list until a specific date","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Allows to get findings list from a specific date","required":false,"type":"string"},{"name":"page","in":"query","description":"Requested page","required":false,"type":"number"},{"name":"size","in":"query","description":"Requested page size","required":false,"type":"number"},{"name":"sortBy","in":"query","description":"Sorting criteria. Supported fields: max_score, findings_count (use - for descending order. E.g.: -max_score)","required":false,"type":"string"},{"name":"status","in":"query","description":"Findings Status","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Findings_targets_list"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings/targets/{target_id}":{"get":{"tags":["findings"],"summary":"Find findings from a Target findings","description":"Find all findings from a team and target.","operationId":"findings#Find findings from a Target","produces":["findings_list"],"parameters":[{"name":"atDate","in":"query","description":"Allows to get findings list at a specific date (incompatible and preferential to min and max date params)","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of identifiers","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Allows to get findings list until a specific date","required":false,"type":"string"},{"name":"maxScore","in":"query","description":"Findings maximum score","required":false,"type":"number"},{"name":"minDate","in":"query","description":"Allows to get findings list from a specific date","required":false,"type":"string"},{"name":"minScore","in":"query","description":"Findings minimum score","required":false,"type":"number"},{"name":"page","in":"query","description":"Requested page","required":false,"type":"number"},{"name":"size","in":"query","description":"Requested page size","required":false,"type":"number"},{"name":"sortBy","in":"query","description":"Sorting criteria. Supported fields: score, -score (for descending order)","required":false,"type":"string"},{"name":"status","in":"query","description":"Findings Status","required":false,"type":"string"},{"name":"target_id","in":"path","description":"Target ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Findings_list"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings/{finding_id}":{"get":{"tags":["findings"],"summary":"Find finding findings","description":"Find a finding.","operationId":"findings#Find finding","produces":["finding"],"parameters":[{"name":"finding_id","in":"path","description":"Finding ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Finding"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings/{finding_id}/overwrites":{"get":{"tags":["findings"],"summary":"List Finding Overwrites findings","description":"List Finding Overwrites.","operationId":"findings#List Finding Overwrites","produces":["finding_overwrite; type=collection"],"parameters":[{"name":"finding_id","in":"path","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Finding_overwriteCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["findings"],"summary":"Submit a Finding Overwrite findings","description":"Overwrite data for a specific finding.","operationId":"findings#Submit a Finding Overwrite","produces":["findings_list"],"parameters":[{"name":"finding_id","in":"path","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/FindingOverwritePayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Findings_list"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/findings/{finding_id}/ticket":{"post":{"tags":["findings"],"summary":"Submit a Finding Ticket Creation findings","description":"Create a ticket associated with the finding in a ticket tracker tool.","operationId":"findings#Submit a Finding Ticket Creation","produces":["finding_ticket"],"parameters":[{"name":"finding_id","in":"path","description":"Finding ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/FindingTicketPayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Finding_ticket"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/groups":{"get":{"tags":["group"],"summary":"list group","description":"List all groups of assets from a team.","operationId":"group#list","produces":["group; type=collection"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GroupCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["group"],"summary":"create group","description":"Create a new group of assets.","operationId":"group#create","produces":["group"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/GroupPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Group"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/groups/{group_id}":{"get":{"tags":["group"],"summary":"show group","description":"Describe a group of assets.","operationId":"group#show","produces":["group"],"parameters":[{"name":"group_id","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Group"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["group"],"summary":"delete group","description":"Delete a group of assets.","operationId":"group#delete","parameters":[{"name":"group_id","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["group"],"summary":"update group","description":"Update a group of assets.","operationId":"group#update","produces":["group"],"parameters":[{"name":"group_id","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/GroupPayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Group"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/groups/{group_id}/assets":{"get":{"tags":["asset-group"],"summary":"list asset-group","description":"List all assets from a group.","operationId":"asset-group#list","produces":["asset; type=collection"],"parameters":[{"name":"group_id","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AssetCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["asset-group"],"summary":"create asset-group","description":"Associate an asset to a group.","operationId":"asset-group#create","produces":["asset"],"parameters":[{"name":"group_id","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/AssetGroupPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Asset"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/groups/{group_id}/assets/{asset_id}":{"delete":{"tags":["asset-group"],"summary":"delete asset-group","description":"Remove an asset from a group.","operationId":"asset-group#delete","parameters":[{"name":"asset_id","in":"path","description":"Asset ID","required":true,"type":"string"},{"name":"group_id","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/members":{"get":{"tags":["team-members"],"summary":"list team-members","description":"List all members from a team.","operationId":"team-members#list","produces":["teammember; type=collection"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeammemberCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["team-members"],"summary":"create team-members","description":"Create a team-member association.\n\t\t\t---\n\t\t\tAt least one of the following fields must be specified: \"email\", \"user_id\".\n\t\t\tOtherwise the operation will fail.\n\t\t\tIf an email is specified, but the user does not exists on the database yet, a new user will be created for that email.\n\t\t\t---\n\t\t\tValid values for 'role' attribute:\n\t\t\t- member\n\t\t\t- owner","operationId":"team-members#create","produces":["teammember"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/TeamMemberPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Teammember"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/members/{user_id}":{"get":{"tags":["team-members"],"summary":"show team-members","description":"Describe a team-member association.","operationId":"team-members#show","produces":["teammember"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"user_id","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Teammember"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["team-members"],"summary":"delete team-members","description":"Delete a member from a team.","operationId":"team-members#delete","parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"user_id","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["team-members"],"summary":"update team-members","description":"Update a team-member association. \nValid values for 'role' attribute: 'member', 'owner'.","operationId":"team-members#update","produces":["teammember"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"user_id","in":"path","description":"User ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/TeamMemberUpdatePayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Teammember"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/policies":{"get":{"tags":["policies"],"summary":"list policies","description":"List all policies from a team.","operationId":"policies#list","produces":["policy; type=collection"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PolicyCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["policies"],"summary":"create policies","description":"Create a new policy.","operationId":"policies#create","produces":["policy"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/PolicyPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Policy"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/policies/{policy_id}":{"get":{"tags":["policies"],"summary":"show policies","description":"Show information about a policy.","operationId":"policies#show","produces":["policy"],"parameters":[{"name":"policy_id","in":"path","description":"Policy ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Policy"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["policies"],"summary":"delete policies","description":"Delete a policy.","operationId":"policies#delete","parameters":[{"name":"policy_id","in":"path","description":"Policy ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["policies"],"summary":"update policies","description":"Update information about a policy.","operationId":"policies#update","produces":["policy"],"parameters":[{"name":"policy_id","in":"path","description":"Policy ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/PolicyUpdatePayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Policy"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/policies/{policy_id}/settings":{"get":{"tags":["policy-settings"],"summary":"list policy-settings","description":"List settings for a policy.","operationId":"policy-settings#list","produces":["policysetting; type=collection"],"parameters":[{"name":"policy_id","in":"path","description":"Policy ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PolicysettingCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["policy-settings"],"summary":"create policy-settings","description":"Create a new policy setting.","operationId":"policy-settings#create","produces":["policysetting"],"parameters":[{"name":"policy_id","in":"path","description":"Policy ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/PolicySettingPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Policysetting"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/policies/{policy_id}/settings/{settings_id}":{"get":{"tags":["policy-settings"],"summary":"show policy-settings","description":"Describe a policy setting.","operationId":"policy-settings#show","produces":["policysetting"],"parameters":[{"name":"policy_id","in":"path","description":"Policy ID","required":true,"type":"string"},{"name":"settings_id","in":"path","description":"CheckType Settings ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Policysetting"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["policy-settings"],"summary":"delete policy-settings","description":"Delete a policy setting.","operationId":"policy-settings#delete","parameters":[{"name":"policy_id","in":"path","description":"Policy ID","required":true,"type":"string"},{"name":"settings_id","in":"path","description":"Policy Settings ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["policy-settings"],"summary":"update policy-settings","description":"Update a policy setting.","operationId":"policy-settings#update","produces":["policysetting"],"parameters":[{"name":"policy_id","in":"path","description":"Policy ID","required":true,"type":"string"},{"name":"settings_id","in":"path","description":"Policy Settings ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/PolicySettingUploadPayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Policysetting"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/programs":{"get":{"tags":["programs"],"summary":"list programs","description":"List all programs from a team.","operationId":"programs#list","produces":["program; type=collection"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ProgramCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["programs"],"summary":"create programs","description":"Create a new program.","operationId":"programs#create","produces":["program"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/ProgramPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Program"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/programs/{program_id}":{"get":{"tags":["programs"],"summary":"show programs","description":"Show information about a program.","operationId":"programs#show","produces":["program"],"parameters":[{"name":"program_id","in":"path","description":"Program ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Program"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["programs"],"summary":"delete programs","description":"Delete a program.","operationId":"programs#delete","parameters":[{"name":"program_id","in":"path","description":"Program ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["programs"],"summary":"update programs","description":"Update information about a program.","operationId":"programs#update","produces":["program"],"parameters":[{"name":"program_id","in":"path","description":"Program ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/ProgramUpdatePayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Program"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/programs/{program_id}/scans":{"get":{"tags":["program-scans"],"summary":"list program-scans","description":"List the scans of a program.","operationId":"program-scans#list","produces":["scan; type=collection"],"parameters":[{"name":"program_id","in":"path","description":"Program ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ScanCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/programs/{program_id}/schedule":{"post":{"tags":["schedule"],"summary":"update schedule","description":"Update information about a schedule.","operationId":"schedule#update","produces":["schedule"],"parameters":[{"name":"program_id","in":"path","description":"Program ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleUpdatePayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Schedule"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["schedule"],"summary":"delete schedule","description":"Delete a schedule.","operationId":"schedule#delete","parameters":[{"name":"program_id","in":"path","description":"Program ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/recipients":{"get":{"tags":["recipients"],"summary":"list recipients","description":"List all recipients from a team.","operationId":"recipients#list","produces":["recipient; type=collection"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RecipientCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"put":{"tags":["recipients"],"summary":"update recipients","description":"Update team recipients.","operationId":"recipients#update","produces":["recipient; type=collection"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/RecipientsPayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RecipientCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/report/digest":{"post":{"tags":["report"],"summary":"send digest report","description":"Send digest report.\nIf no dates are specified, the time range will be set for the last 30 days.","operationId":"report#send digest","produces":["text/plain"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/DigestPayload"}}],"responses":{"200":{"description":"OK"}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/scans":{"post":{"tags":["scan"],"summary":"create scan","description":"Create scan","operationId":"scan#create","produces":["scan"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/ScanPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Scan"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/scans/{scan_id}":{"get":{"tags":["scan"],"summary":"show scan","description":"Describe scan","operationId":"scan#show","produces":["scan"],"parameters":[{"name":"scan_id","in":"path","description":"Scan ID","required":true,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Scan"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/stats/coverage":{"get":{"tags":["stats"],"summary":"coverage stats","description":"Get asset coverage for a team.","operationId":"stats#coverage","produces":["statscoverage"],"parameters":[{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Statscoverage"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/stats/exposure":{"get":{"tags":["stats"],"summary":"exposure stats","description":"Get exposure statistics for a team. This metric takes into account the exposure across all lifecycle of vulnerabilities.","operationId":"stats#exposure","produces":["exposure"],"parameters":[{"name":"atDate","in":"query","description":"Specific date to get statistics at","required":false,"type":"string"},{"name":"maxScore","in":"query","description":"Maximum issues score filter","required":false,"type":"number"},{"name":"minScore","in":"query","description":"Minimum issues score filter","required":false,"type":"number"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Exposure"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/stats/exposure/current":{"get":{"tags":["stats"],"summary":"current exposure stats","description":"Get current exposure statistics for a team. This metric takes into account only the exposure for open vulnerabilities since the last time they were detected.","operationId":"stats#current exposure","produces":["current_exposure"],"parameters":[{"name":"maxScore","in":"query","description":"Maximum issues score filter","required":false,"type":"number"},{"name":"minScore","in":"query","description":"Minimum issues score filter","required":false,"type":"number"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Current_exposure"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/stats/fixed":{"get":{"tags":["stats"],"summary":"fixed stats","description":"Get fixed issues statistics for a team.","operationId":"stats#fixed","produces":["statsfixed"],"parameters":[{"name":"atDate","in":"query","description":"Specific date to get statistics at (incompatible and preferential to min and max date params)","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of asset identifiers","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Maximum date to filter statistics by","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Minimum date to filter statistics by","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Statsfixed"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/stats/mttr":{"get":{"tags":["stats"],"summary":"mttr stats","description":"Get MTR statistics for a team.","operationId":"stats#mttr","produces":["mttr"],"parameters":[{"name":"maxDate","in":"query","description":"Maximum date to filter statistics by","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Minimum date to filter statistics by","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Mttr"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/teams/{team_id}/stats/open":{"get":{"tags":["stats"],"summary":"open stats","description":"Get open issues statistics for a team.","operationId":"stats#open","produces":["statsopen"],"parameters":[{"name":"atDate","in":"query","description":"Specific date to get statistics at (incompatible and preferential to min and max date params)","required":false,"type":"string"},{"name":"identifiers","in":"query","description":"A comma separated list of asset identifiers","required":false,"type":"string"},{"name":"labels","in":"query","description":"A comma separated list of associated labels","required":false,"type":"string"},{"name":"maxDate","in":"query","description":"Maximum date to filter statistics by","required":false,"type":"string"},{"name":"minDate","in":"query","description":"Minimum date to filter statistics by","required":false,"type":"string"},{"name":"team_id","in":"path","description":"Team ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Statsopen"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/users":{"get":{"tags":["user"],"summary":"list user","description":"List all users","operationId":"user#list","produces":["user; type=collection"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"post":{"tags":["user"],"summary":"create user","description":"Create user","operationId":"user#create","produces":["user"],"parameters":[{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/UserPayload"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/User"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/users/{user_id}":{"get":{"tags":["user"],"summary":"show user","description":"Describe user","operationId":"user#show","produces":["user"],"parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/User"}}},"schemes":["https"],"security":[{"Bearer":[]}]},"delete":{"tags":["user"],"summary":"delete user","description":"Remove user","operationId":"user#delete","parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"schemes":["https"],"security":[{"Bearer":[]}]},"patch":{"tags":["user"],"summary":"update user","description":"Update user","operationId":"user#update","produces":["user"],"parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"type":"string"},{"name":"payload","in":"body","required":true,"schema":{"$ref":"#/definitions/UserUpdatePayload"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/User"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/users/{user_id}/teams":{"get":{"tags":["user"],"summary":"list-teams user","description":"List all teams for an user.","operationId":"user#list-teams","produces":["team; type=collection"],"parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TeamCollection"}}},"schemes":["https"],"security":[{"Bearer":[]}]}},"/users/{user_id}/token":{"post":{"tags":["api-token"],"summary":"create api-token","description":"Generate an API token for an user.","operationId":"api-token#create","produces":["token"],"parameters":[{"name":"user_id","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Token"}}},"schemes":["https"],"security":[{"Bearer":[]}]}}},"definitions":{"Asset":{"title":"Mediatype identifier: asset; view=default","type":"object","properties":{"alias":{"type":"string","description":"Alias","example":"AnAlias"},"annotations":{"type":"object","example":{"annotation/1":"value/1","annotation/2":"value/2"},"additionalProperties":true},"classified_at":{"type":"string","description":"Classified At","example":"2020-09-03T15:00:42.112975Z"},"environmental_cvss":{"type":"string","description":"Environmental CVSS","example":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H"},"id":{"type":"string","description":"Asset ID","example":"a8720503-0284-45fd-9cf4-5bb6c500966f"},"identifier":{"type":"string","description":"Identifier","example":"vulcan.example.com"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"},"rolfp":{"type":"string","description":"Rolfp plus scope vector","example":"R:1/O:1/L:0/F:0/P:0+S:1"},"scannable":{"type":"boolean","description":"Scannable","example":true},"type":{"$ref":"#/definitions/Assettype"}},"description":"Asset (default view)","example":{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}}},"AssetAnnotationDeleteRequest":{"title":"AssetAnnotationDeleteRequest","type":"object","properties":{"annotations":{"type":"array","items":{"type":"string","example":"Est illo et corrupti rerum deleniti aut."},"example":["annotation/1","annotation/2"]}},"example":{"annotations":["annotation/1","annotation/2"]}},"AssetAnnotationRequest":{"title":"AssetAnnotationRequest","type":"object","properties":{"annotations":{"type":"object","example":{"annotation/1":"value/1","annotation/2":"value/2"},"additionalProperties":true}},"example":{"annotations":{"annotation/1":"value/1","annotation/2":"value/2"}}},"AssetCollection":{"title":"Mediatype identifier: asset; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Asset"},"description":"AssetCollection is the media type for an array of Asset (default view)","example":[{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}},{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}}]},"AssetGroupPayload":{"title":"AssetGroupPayload","type":"object","properties":{"asset_id":{"type":"string","description":"Asset ID","example":"0fc67150-5cd9-486a-aca5-9c9167478e4d"}},"example":{"asset_id":"0fc67150-5cd9-486a-aca5-9c9167478e4d"},"required":["asset_id"]},"AssetPayload":{"title":"AssetPayload","type":"object","properties":{"alias":{"type":"string","description":"The alias of the asset in Vulcan","example":"AnAlias"},"environmental_cvss":{"type":"string","description":"Environmental CVSS","example":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H"},"identifier":{"type":"string","description":"Identifier","example":"vulcan.example.com"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"},"rolfp":{"type":"string","description":"Rolfp plus scope vector","example":"R:1/O:1/L:0/F:0/P:0+S:1"},"scannable":{"type":"boolean","description":"Scannable","example":true},"type":{"type":"string","description":"Type","example":"Hostname"}},"example":{"alias":"AnAlias","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},"required":["identifier"]},"AssetUpdatePayload":{"title":"AssetUpdatePayload","type":"object","properties":{"alias":{"type":"string","description":"Alias","example":"AnAlias"},"environmental_cvss":{"type":"string","description":"Environmental CVSS","example":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H"},"identifier":{"type":"string","description":"Identifier","example":"vulcan.example.com"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"},"rolfp":{"type":"string","description":"Rolfp plus scope vector","example":"R:1/O:1/L:0/F:0/P:0+S:1"},"scannable":{"type":"boolean","description":"Scannable","example":true},"type":{"type":"string","description":"Type","example":"Hostname"}},"example":{"alias":"AnAlias","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"}},"AssetWithAnnotationsPayload":{"title":"AssetWithAnnotationsPayload","type":"object","properties":{"alias":{"type":"string","description":"The alias of the asset in Vulcan","example":"AnAlias"},"annotations":{"type":"object","description":"The provided annotations may differ from the ones that\nwill be stored, because they will include a prefix to not mess with any other\nannotations already present in the asset.","example":{"annotation/1":"value/1","annotation/2":"value/2"},"additionalProperties":true},"environmental_cvss":{"type":"string","description":"Environmental CVSS","example":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H"},"identifier":{"type":"string","description":"Identifier","example":"vulcan.example.com"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"},"rolfp":{"type":"string","description":"Rolfp plus scope vector","example":"R:1/O:1/L:0/F:0/P:0+S:1"},"scannable":{"type":"boolean","description":"Scannable","example":true},"type":{"type":"string","description":"Type","example":"Hostname"}},"example":{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},"required":["identifier","type"]},"Assetannotations_response":{"title":"Mediatype identifier: assetannotations_response; view=default","type":"object","properties":{"annotations":{"type":"object","example":{"annotation/1":"value/1","annotation/2":"value/2"},"additionalProperties":true}},"description":"Asset Annotations (default view)","example":{"annotations":{"annotation/1":"value/1","annotation/2":"value/2"}}},"Assetresponse":{"title":"Mediatype identifier: assetresponse; view=default","type":"object","properties":{"alias":{"type":"string","description":"Alias","example":"AnAlias"},"classified_at":{"type":"string","description":"Classified At","example":"2020-09-03T15:00:42.112975Z"},"environmental_cvss":{"type":"string","description":"Environmental CVSS","example":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H"},"id":{"type":"string","description":"Asset ID","example":"a8720503-0284-45fd-9cf4-5bb6c500966f"},"identifier":{"type":"string","description":"Identifier","example":"vulcan.example.com"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"},"rolfp":{"type":"string","description":"Rolfp plus scope vector","example":"R:1/O:1/L:0/F:0/P:0+S:1"},"scannable":{"type":"boolean","description":"Scannable","example":true},"status":{"$ref":"#/definitions/Error"},"type":{"$ref":"#/definitions/Assettype"}},"description":"Asset (default view)","example":{"alias":"AnAlias","classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"status":{"code":3944598920153519998,"error":"Quo placeat magni harum ea.","type":"Voluptatum mollitia consequuntur dignissimos."},"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}}},"AssetresponseCollection":{"title":"Mediatype identifier: assetresponse; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Assetresponse"},"description":"AssetresponseCollection is the media type for an array of Assetresponse (default view)","example":[{"alias":"AnAlias","classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"status":{"code":3944598920153519998,"error":"Quo placeat magni harum ea.","type":"Voluptatum mollitia consequuntur dignissimos."},"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}},{"alias":"AnAlias","classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"status":{"code":3944598920153519998,"error":"Quo placeat magni harum ea.","type":"Voluptatum mollitia consequuntur dignissimos."},"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}}]},"Assettype":{"title":"Mediatype identifier: assettype; view=default","type":"object","properties":{"id":{"type":"string","description":"Asset Type ID","example":"29f83d16-09c4-4be5-8cae-e232d41f388a"},"name":{"type":"string","description":"Name","example":"Hostname"}},"description":"Asset Type (default view)","example":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}},"Attachment":{"title":"Mediatype identifier: attachment; view=default","type":"object","properties":{"content_type":{"type":"string","description":"Content Type of the attachment","example":"application/json"},"data":{"description":"attachment data","example":"e30="},"name":{"type":"string","description":"Attachment name","example":"JSON string"}},"description":"attachment (default view)","example":{"content_type":"application/json","data":"e30=","name":"JSON string"}},"CreateAssetPayload":{"title":"CreateAssetPayload","type":"object","properties":{"annotations":{"type":"object","example":{"annotation/1":"value/1","annotation/2":"value/2"},"additionalProperties":true},"assets":{"type":"array","items":{"$ref":"#/definitions/AssetPayload"},"example":[{"alias":"AnAlias","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},{"alias":"AnAlias","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},{"alias":"AnAlias","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"}]},"groups":{"type":"array","items":{"type":"string","example":"Porro placeat omnis perferendis maxime natus."},"example":["a14c7c65-66ab-4676-bcf6-0dea9719f5c6","9f7a0c78-b752-4126-aa6d-0f286ada7b8f"]}},"example":{"annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"assets":[{"alias":"AnAlias","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},{"alias":"AnAlias","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},{"alias":"AnAlias","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"}],"groups":["a14c7c65-66ab-4676-bcf6-0dea9719f5c6","9f7a0c78-b752-4126-aa6d-0f286ada7b8f"]},"required":["assets"]},"Current_exposure":{"title":"Mediatype identifier: current_exposure; view=default","type":"object","properties":{"current_exposure":{"$ref":"#/definitions/Statsaverages"}},"description":"Current exposure stats (default view)","example":{"current_exposure":{"mean":0.11209448947762005,"percentile_10":0.5075172645112574,"percentile_25":0.5429089680729741,"percentile_50":0.985214296805186,"percentile_75":0.3678803730882772,"percentile_90":0.7278236287555608}}},"DigestPayload":{"title":"DigestPayload","type":"object","properties":{"end_date":{"type":"string","description":"End Date","example":"2020-09-10"},"start_date":{"type":"string","description":"Start Date","example":"2020-08-11"}},"example":{"end_date":"2020-09-10","start_date":"2020-08-11"}},"DiscoveredAssetsPayload":{"title":"DiscoveredAssetsPayload","type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/definitions/AssetWithAnnotationsPayload"},"example":[{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"}]},"group_name":{"type":"string","description":"The discovery group name where assets will be added. It\n\t\tmust end with '-discovered-assets'. The first part of the name should\n\t\tidentify the discovery service using the endpoint","example":"discoveryserviceX-discovered-assets"}},"example":{"assets":[{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"},{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":"Hostname"}],"group_name":"discoveryserviceX-discovered-assets"},"required":["group_name"]},"Error":{"title":"Mediatype identifier: error; view=default","type":"object","properties":{"code":{"type":"integer","description":"Code","example":3944598920153519998,"format":"int64"},"error":{"type":"string","description":"Error","example":"Quo placeat magni harum ea."},"type":{"type":"string","description":"Type","example":"Voluptatum mollitia consequuntur dignissimos."}},"description":"Error (default view)","example":{"code":3944598920153519998,"error":"Quo placeat magni harum ea.","type":"Voluptatum mollitia consequuntur dignissimos."},"required":["code","error","type"]},"Exposure":{"title":"Mediatype identifier: exposure; view=default","type":"object","properties":{"exposure":{"$ref":"#/definitions/Statsaverages"}},"description":"Exposure stats (default view)","example":{"exposure":{"mean":0.11209448947762005,"percentile_10":0.5075172645112574,"percentile_25":0.5429089680729741,"percentile_50":0.985214296805186,"percentile_75":0.3678803730882772,"percentile_90":0.7278236287555608}}},"Finding":{"title":"Mediatype identifier: finding; view=default","type":"object","properties":{"affected_resource":{"type":"string","description":"Affected Resource","example":""},"attachments":{"type":"array","items":{"$ref":"#/definitions/Attachment"},"description":"Attachments","example":[{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"}]},"current_exposure":{"type":"number","description":"Current exposure (hours). Only for OPEN findings","example":4631,"format":"double"},"details":{"type":"string","description":"Details","example":""},"id":{"type":"string","description":"Finding ID","example":"a8720503-0284-45fd-9cf4-5bb6c500966f"},"impact_details":{"type":"string","description":"Impact details","example":""},"issue":{"$ref":"#/definitions/Issue"},"resources":{"type":"array","items":{"$ref":"#/definitions/Resource"},"description":"Resources","example":[{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]},{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]}]},"score":{"type":"number","description":"Score","example":6.9,"format":"double"},"source":{"$ref":"#/definitions/Source"},"status":{"type":"string","description":"Status","example":"OPEN"},"target":{"$ref":"#/definitions/Target"},"total_exposure":{"type":"number","description":"Total exposure (hours)","example":4631,"format":"double"},"url_tracker":{"type":"string","description":"Link to the ticket","example":"https://jiraserver.example.com/browse/TEST-123"}},"description":"Finding (default view)","example":{"affected_resource":"","attachments":[{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"}],"current_exposure":4631,"details":"","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","impact_details":"","issue":{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"},"resources":[{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]},{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]}],"score":6.9,"source":{"component":"vulcan-tls","id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","instance":"b3320f03-1284-42fd-9cf4-5bb6c500966f","name":"vulcan","options":"{\"timeout\":60}","time":"2019-06-08 11:16:40"},"status":"OPEN","target":{"id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","identifier":"www.test.com","teams":["a9d33628-ddb0-467c-b482-474887097820","9cb0bb2b-ca36-4877-acad-9dde23880595"]},"total_exposure":4631,"url_tracker":"https://jiraserver.example.com/browse/TEST-123"}},"FindingCollection":{"title":"Mediatype identifier: finding; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Finding"},"description":"FindingCollection is the media type for an array of Finding (default view)","example":[{"affected_resource":"","attachments":[{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"}],"current_exposure":4631,"details":"","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","impact_details":"","issue":{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"},"resources":[{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]},{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]}],"score":6.9,"source":{"component":"vulcan-tls","id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","instance":"b3320f03-1284-42fd-9cf4-5bb6c500966f","name":"vulcan","options":"{\"timeout\":60}","time":"2019-06-08 11:16:40"},"status":"OPEN","target":{"id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","identifier":"www.test.com","teams":["a9d33628-ddb0-467c-b482-474887097820","9cb0bb2b-ca36-4877-acad-9dde23880595"]},"total_exposure":4631,"url_tracker":"https://jiraserver.example.com/browse/TEST-123"},{"affected_resource":"","attachments":[{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"}],"current_exposure":4631,"details":"","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","impact_details":"","issue":{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"},"resources":[{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]},{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]}],"score":6.9,"source":{"component":"vulcan-tls","id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","instance":"b3320f03-1284-42fd-9cf4-5bb6c500966f","name":"vulcan","options":"{\"timeout\":60}","time":"2019-06-08 11:16:40"},"status":"OPEN","target":{"id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","identifier":"www.test.com","teams":["a9d33628-ddb0-467c-b482-474887097820","9cb0bb2b-ca36-4877-acad-9dde23880595"]},"total_exposure":4631,"url_tracker":"https://jiraserver.example.com/browse/TEST-123"},{"affected_resource":"","attachments":[{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"}],"current_exposure":4631,"details":"","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","impact_details":"","issue":{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"},"resources":[{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]},{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]}],"score":6.9,"source":{"component":"vulcan-tls","id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","instance":"b3320f03-1284-42fd-9cf4-5bb6c500966f","name":"vulcan","options":"{\"timeout\":60}","time":"2019-06-08 11:16:40"},"status":"OPEN","target":{"id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","identifier":"www.test.com","teams":["a9d33628-ddb0-467c-b482-474887097820","9cb0bb2b-ca36-4877-acad-9dde23880595"]},"total_exposure":4631,"url_tracker":"https://jiraserver.example.com/browse/TEST-123"}]},"FindingOverwritePayload":{"title":"FindingOverwritePayload","type":"object","properties":{"notes":{"type":"string","description":"Notes","example":"This is a false positive because..."},"status":{"type":"string","description":"Status","example":"FALSE_POSITIVE"}},"example":{"notes":"This is a false positive because...","status":"FALSE_POSITIVE"},"required":["status","notes"]},"FindingTicketPayload":{"title":"FindingTicketPayload","type":"object","properties":{"description":{"type":"string","description":"Description","example":"A text with a custom description about the finding."},"labels":{"type":"array","items":{"type":"string","example":"Est autem doloribus."},"description":"Jira issue labels","example":["potential"]},"summary":{"type":"string","description":"Summary","example":"Dockerfile Security Check - Image user should not be 'root'"}},"example":{"description":"A text with a custom description about the finding.","labels":["potential"],"summary":"Dockerfile Security Check - Image user should not be 'root'"},"required":["summary"]},"Finding_overwrite":{"title":"Mediatype identifier: finding_overwrite; view=default","type":"object","properties":{"created_at":{"type":"string","description":"Creation time","example":"2021-03-27T00:26:43.211506Z","format":"date-time"},"finding_id":{"type":"string","description":"Finding ID","example":"3c7d7003-c53d-4ccc-80e7-f21da241b2d4"},"id":{"type":"string","description":"Finding Overwrite ID","example":"b0720503-0a84-43fd-9cf4-5bb6c500226f"},"notes":{"type":"string","description":"Complementary information","example":"This finding is a false positive because..."},"status":{"type":"string","description":"The status requested for the finding referenced by the finding_id field","example":"FALSE_POSITIVE"},"status_previous":{"type":"string","description":"The previous status for the finding referenced by the finding_id field","example":"OPEN"},"team_id":{"type":"string","description":"The ID associated to the team who requested this overwrite","example":"a9d33628-ddb0-467c-b482-474887097820"},"user":{"type":"string","description":"User who requested the finding overwrite","example":"user@adevinta.com"}},"description":"Finding Overwrite (default view)","example":{"created_at":"2021-03-27T00:26:43.211506Z","finding_id":"3c7d7003-c53d-4ccc-80e7-f21da241b2d4","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","notes":"This finding is a false positive because...","status":"FALSE_POSITIVE","status_previous":"OPEN","team_id":"a9d33628-ddb0-467c-b482-474887097820","user":"user@adevinta.com"}},"Finding_overwriteCollection":{"title":"Mediatype identifier: finding_overwrite; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Finding_overwrite"},"description":"Finding_overwriteCollection is the media type for an array of Finding_overwrite (default view)","example":[{"created_at":"2021-03-27T00:26:43.211506Z","finding_id":"3c7d7003-c53d-4ccc-80e7-f21da241b2d4","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","notes":"This finding is a false positive because...","status":"FALSE_POSITIVE","status_previous":"OPEN","team_id":"a9d33628-ddb0-467c-b482-474887097820","user":"user@adevinta.com"}]},"Finding_ticket":{"title":"Mediatype identifier: finding_ticket; view=default","type":"object","properties":{"url_tracker":{"type":"string","description":"Link to the ticket","example":"https://jiraserver.example.com/browse/TEST-123"}},"description":"Finding Ticket (default view)","example":{"url_tracker":"https://jiraserver.example.com/browse/TEST-123"}},"Findings_issue":{"title":"Mediatype identifier: findings_issue; view=default","type":"object","properties":{"issue_id":{"type":"string","description":"Issue ID","example":"a8720503-0284-45fd-9cf4-5bb6c500966f"},"max_score":{"type":"number","description":"Max score for the issue among the affected assets","example":6.9,"format":"double"},"resources_count":{"type":"number","description":"Number of affected resources by the issue","example":28,"format":"double"},"summary":{"type":"string","description":"Issue summary","example":"Site Without HTTPS"},"targets_count":{"type":"number","description":"Number of targets affected by the issue","example":14,"format":"double"}},"description":"Findings by Issue (default view)","example":{"issue_id":"a8720503-0284-45fd-9cf4-5bb6c500966f","max_score":6.9,"resources_count":28,"summary":"Site Without HTTPS","targets_count":14}},"Findings_issueCollection":{"title":"Mediatype identifier: findings_issue; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Findings_issue"},"description":"Findings_issueCollection is the media type for an array of Findings_issue (default view)","example":[{"issue_id":"a8720503-0284-45fd-9cf4-5bb6c500966f","max_score":6.9,"resources_count":28,"summary":"Site Without HTTPS","targets_count":14},{"issue_id":"a8720503-0284-45fd-9cf4-5bb6c500966f","max_score":6.9,"resources_count":28,"summary":"Site Without HTTPS","targets_count":14}]},"Findings_issues_list":{"title":"Mediatype identifier: findings_issues_list; view=default","type":"object","properties":{"issues":{"$ref":"#/definitions/Findings_issueCollection"},"pagination":{"$ref":"#/definitions/Pagination"}},"description":"Findings by Issue list (default view)","example":{"issues":[{"issue_id":"a8720503-0284-45fd-9cf4-5bb6c500966f","max_score":6.9,"resources_count":28,"summary":"Site Without HTTPS","targets_count":14},{"issue_id":"a8720503-0284-45fd-9cf4-5bb6c500966f","max_score":6.9,"resources_count":28,"summary":"Site Without HTTPS","targets_count":14}],"pagination":{"limit":0.04495248178158175,"more":false,"offset":0.9837483587621623,"total":0.7345756811206027}}},"Findings_labels":{"title":"Mediatype identifier: findings_labels; view=default","type":"object","properties":{"labels":{"type":"array","items":{"type":"string","example":"At ut."},"description":"associated labels","example":["Web","HTTP"]}},"description":"Findings Labels (default view)","example":{"labels":["Web","HTTP"]}},"Findings_list":{"title":"Mediatype identifier: findings_list; view=default","type":"object","properties":{"findings":{"$ref":"#/definitions/FindingCollection"},"pagination":{"$ref":"#/definitions/Pagination"}},"description":"Findings list (default view)","example":{"findings":[{"affected_resource":"","attachments":[{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"},{"content_type":"application/json","data":"e30=","name":"JSON string"}],"current_exposure":4631,"details":"","id":"a8720503-0284-45fd-9cf4-5bb6c500966f","impact_details":"","issue":{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"},"resources":[{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]},{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]}],"score":6.9,"source":{"component":"vulcan-tls","id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","instance":"b3320f03-1284-42fd-9cf4-5bb6c500966f","name":"vulcan","options":"{\"timeout\":60}","time":"2019-06-08 11:16:40"},"status":"OPEN","target":{"id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","identifier":"www.test.com","teams":["a9d33628-ddb0-467c-b482-474887097820","9cb0bb2b-ca36-4877-acad-9dde23880595"]},"total_exposure":4631,"url_tracker":"https://jiraserver.example.com/browse/TEST-123"}],"pagination":{"limit":0.04495248178158175,"more":false,"offset":0.9837483587621623,"total":0.7345756811206027}}},"Findings_target":{"title":"Mediatype identifier: findings_target; view=default","type":"object","properties":{"findings_count":{"type":"number","description":"Number of findings for the target","example":5,"format":"double"},"identifier":{"type":"string","description":"Target Identifier","example":"vulcan.example.com"},"issues_count":{"type":"number","description":"Number of issues for the target","example":2,"format":"double"},"max_score":{"type":"number","description":"Max score for the issue among the affected assets","example":6.9,"format":"double"},"target_id":{"type":"string","description":"Target ID","example":"a8720503-0284-45fd-9cf4-5bb6c500966f"}},"description":"Findings by Target (default view)","example":{"findings_count":5,"identifier":"vulcan.example.com","issues_count":2,"max_score":6.9,"target_id":"a8720503-0284-45fd-9cf4-5bb6c500966f"}},"Findings_targetCollection":{"title":"Mediatype identifier: findings_target; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Findings_target"},"description":"Findings_targetCollection is the media type for an array of Findings_target (default view)","example":[{"findings_count":5,"identifier":"vulcan.example.com","issues_count":2,"max_score":6.9,"target_id":"a8720503-0284-45fd-9cf4-5bb6c500966f"}]},"Findings_targets_list":{"title":"Mediatype identifier: findings_targets_list; view=default","type":"object","properties":{"pagination":{"$ref":"#/definitions/Pagination"},"targets":{"$ref":"#/definitions/Findings_targetCollection"}},"description":"Findings by Target list (default view)","example":{"pagination":{"limit":0.04495248178158175,"more":false,"offset":0.9837483587621623,"total":0.7345756811206027},"targets":[{"findings_count":5,"identifier":"vulcan.example.com","issues_count":2,"max_score":6.9,"target_id":"a8720503-0284-45fd-9cf4-5bb6c500966f"},{"findings_count":5,"identifier":"vulcan.example.com","issues_count":2,"max_score":6.9,"target_id":"a8720503-0284-45fd-9cf4-5bb6c500966f"}]}},"Group":{"title":"Mediatype identifier: group; view=default","type":"object","properties":{"assets_count":{"type":"integer","description":"Assets Count","example":1,"format":"int64"},"description":{"type":"string","description":"Description","example":"All newly created assets are added to the Default group"},"id":{"type":"string","description":"Group ID","example":"f6360346-77a5-4f97-b919-331363b3af26"},"name":{"type":"string","description":"Name","example":"Default group"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"}},"description":"Group (default view)","example":{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"}},"GroupCollection":{"title":"Mediatype identifier: group; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Group"},"description":"GroupCollection is the media type for an array of Group (default view)","example":[{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"}]},"GroupPayload":{"title":"GroupPayload","type":"object","properties":{"name":{"type":"string","description":"name","example":"Default group"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"}},"example":{"name":"Default group","options":"{\"timeout\":60}"},"required":["name"]},"GroupWithoutAssetsCount":{"title":"Mediatype identifier: group; view=WithoutAssetsCount","type":"object","properties":{"description":{"type":"string","description":"Description","example":"All newly created assets are added to the Default group"},"id":{"type":"string","description":"Group ID","example":"f6360346-77a5-4f97-b919-331363b3af26"},"name":{"type":"string","description":"Name","example":"Default group"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"}},"description":"Group (WithoutAssetsCount view)","example":{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"}},"GroupWithoutAssetsCountCollection":{"title":"Mediatype identifier: group; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/GroupWithoutAssetsCount"},"description":"GroupWithoutAssetsCountCollection is the media type for an array of GroupWithoutAssetsCount (default view)","example":[{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"}]},"Healthcheck":{"title":"Mediatype identifier: healthcheck; view=default","type":"object","properties":{"status":{"type":"string","description":"Status","example":"OK"}},"description":"Healthcheck (default view)","example":{"status":"OK"}},"Issue":{"title":"Mediatype identifier: issue; view=default","type":"object","properties":{"cwe_id":{"type":"number","description":"Common Weakness Enumeration ID","example":358,"format":"double"},"description":{"type":"string","description":"Issue description","example":"This domain has at least one MX record"},"id":{"type":"string","description":"Issue ID","example":"b0720503-0a84-43fd-9cf4-5bb6c500226f"},"labels":{"type":"array","items":{"type":"string","example":"Ratione perferendis."},"description":"Associated labels","example":["Web","HTTP"]},"recommendations":{"type":"array","items":{"type":"string","example":"Quas voluptatum sit eos illum ipsum tempora."},"description":"Recommendations to fix the issue","example":["It is recommended to run DMARC"]},"reference_links":{"type":"array","items":{"type":"string","example":"Corrupti sed qui."},"description":"Documentation reference for the issue","example":[]},"summary":{"type":"string","description":"Issue summary","example":"MX presence"}},"description":"Issue (default view)","example":{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"}},"IssueCollection":{"title":"Mediatype identifier: issue; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Issue"},"description":"IssueCollection is the media type for an array of Issue (default view)","example":[{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"},{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"}]},"Issues_list":{"title":"Mediatype identifier: issues_list; view=default","type":"object","properties":{"issues":{"$ref":"#/definitions/IssueCollection"},"pagination":{"$ref":"#/definitions/Pagination"}},"description":"Issue list (default view)","example":{"issues":[{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"},{"cwe_id":358,"description":"This domain has at least one MX record","id":"b0720503-0a84-43fd-9cf4-5bb6c500226f","labels":["Web","HTTP"],"recommendations":["It is recommended to run DMARC"],"reference_links":[],"summary":"MX presence"}],"pagination":{"limit":0.04495248178158175,"more":false,"offset":0.9837483587621623,"total":0.7345756811206027}}},"Job":{"title":"Mediatype identifier: job; view=default","type":"object","properties":{"id":{"type":"string","description":"Job ID","example":"967d9966-b561-4233-bd6f-cac603fd8320"},"operation":{"type":"string","description":"Operation that triggered the job","example":"OnboardDiscoveredAssets"},"result":{"type":"object","properties":{"data":{"description":"Optionally populated field when the job finishes correctly, that returns execution related data. The format of the data is defined per operation type","example":"{\"assets : [\"abb77c5e-2442-4673-9d0a-957fb43e416c\", \"2e016860-f772-416d-b551-bf384351dd5f\"}"},"error":{"type":"string","description":"When not empty indicates that the job failed","example":"Invalid asset type"}},"description":"Result of the job operation","example":{"data":"{\"assets : [\"abb77c5e-2442-4673-9d0a-957fb43e416c\", \"2e016860-f772-416d-b551-bf384351dd5f\"}","error":"Invalid asset type"}},"status":{"type":"string","description":"Indicates the status of the operation. The possible values are:\n\t- 'PENDING': The job has been noted and is pending to be processed\n\t- 'RUNNING': The job is on execution\n\t- 'DONE': The job has finished, either successfully or unsuccesfully. Result.error needs to be processed to determine it","example":"PROCESSING"},"team_id":{"type":"string","description":"Team ID","example":"9cb0bb2b-ca36-4877-acad-9dde23880595"}},"description":"Job (default view)","example":{"id":"967d9966-b561-4233-bd6f-cac603fd8320","operation":"OnboardDiscoveredAssets","result":{"data":"{\"assets : [\"abb77c5e-2442-4673-9d0a-957fb43e416c\", \"2e016860-f772-416d-b551-bf384351dd5f\"}","error":"Invalid asset type"},"status":"PROCESSING","team_id":"9cb0bb2b-ca36-4877-acad-9dde23880595"}},"Listassetentry":{"title":"Mediatype identifier: listassetentry; view=default","type":"object","properties":{"alias":{"type":"string","description":"Alias","example":"AnAlias"},"annotations":{"type":"object","example":{"annotation/1":"value/1","annotation/2":"value/2"},"additionalProperties":true},"classified_at":{"type":"string","description":"Classified At","example":"2020-09-03T15:00:42.112975Z"},"environmental_cvss":{"type":"string","description":"Environmental CVSS","example":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H"},"groups":{"$ref":"#/definitions/GroupWithoutAssetsCountCollection"},"id":{"type":"string","description":"Asset ID","example":"a8720503-0284-45fd-9cf4-5bb6c500966f"},"identifier":{"type":"string","description":"Identifier","example":"vulcan.example.com"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"},"rolfp":{"type":"string","description":"Rolfp plus scope vector","example":"R:1/O:1/L:0/F:0/P:0+S:1"},"scannable":{"type":"boolean","description":"Scannable","example":true},"type":{"$ref":"#/definitions/Assettype"}},"description":"List Asset Entry (default view)","example":{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","groups":[{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"}],"id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}}},"ListassetentryCollection":{"title":"Mediatype identifier: listassetentry; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Listassetentry"},"description":"ListassetentryCollection is the media type for an array of Listassetentry (default view)","example":[{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","groups":[{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"}],"id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}},{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","groups":[{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"}],"id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}},{"alias":"AnAlias","annotations":{"annotation/1":"value/1","annotation/2":"value/2"},"classified_at":"2020-09-03T15:00:42.112975Z","environmental_cvss":"AV:N/AC:H/PR:N/UI:R/S:U/C:H/I:H/A:H","groups":[{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},{"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"}],"id":"a8720503-0284-45fd-9cf4-5bb6c500966f","identifier":"vulcan.example.com","options":"{\"timeout\":60}","rolfp":"R:1/O:1/L:0/F:0/P:0+S:1","scannable":true,"type":{"id":"29f83d16-09c4-4be5-8cae-e232d41f388a","name":"Hostname"}}]},"Mttr":{"title":"Mediatype identifier: mttr; view=default","type":"object","properties":{"mttr":{"$ref":"#/definitions/Statstotal"}},"description":"MTTR stats (default view)","example":{"mttr":{"critical":0.3602830379559806,"high":0.6517825863008089,"informational":0.4039820739887437,"low":0.43571544865095874,"medium":0.9513589896198863,"total":0.05810810305338469}}},"Pagination":{"title":"Mediatype identifier: pagination; view=default","type":"object","properties":{"limit":{"type":"number","description":"Limit of results for the list","example":0.04495248178158175,"format":"double"},"more":{"type":"boolean","description":"Indicates if there are more results to query for the list","example":false},"offset":{"type":"number","description":"Results list offset","example":0.9837483587621623,"format":"double"},"total":{"type":"number","description":"Total number of results for the list","example":0.7345756811206027,"format":"double"}},"description":"Pagination info (default view)","example":{"limit":0.04495248178158175,"more":false,"offset":0.9837483587621623,"total":0.7345756811206027}},"Policy":{"title":"Mediatype identifier: policy; view=default","type":"object","properties":{"id":{"type":"string","description":"Policy ID","example":"af36818a-0f30-412c-9692-d37716075861"},"name":{"type":"string","description":"Name","example":"Sample Policy"},"settings_count":{"type":"integer","description":"Policy settings count","example":12,"format":"int64"}},"description":"Policy (default view)","example":{"id":"af36818a-0f30-412c-9692-d37716075861","name":"Sample Policy","settings_count":12}},"PolicyCollection":{"title":"Mediatype identifier: policy; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Policy"},"description":"PolicyCollection is the media type for an array of Policy (default view)","example":[{"id":"af36818a-0f30-412c-9692-d37716075861","name":"Sample Policy","settings_count":12}]},"PolicyPayload":{"title":"PolicyPayload","type":"object","properties":{"name":{"type":"string","description":"name","example":"Sample Policy"}},"example":{"name":"Sample Policy"},"required":["name"]},"PolicySettingPayload":{"title":"PolicySettingPayload","type":"object","properties":{"checktype_name":{"type":"string","description":"Check Type Name","example":"vulcan-tls"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"}},"example":{"checktype_name":"vulcan-tls","options":"{\"timeout\":60}"},"required":["checktype_name"]},"PolicySettingUploadPayload":{"title":"PolicySettingUploadPayload","type":"object","properties":{"checktype_name":{"type":"string","description":"Check Type Name","example":"vulcan-tls"},"options":{"type":"string","description":"Options","example":"{\"timeout\":60}"}},"example":{"checktype_name":"vulcan-tls","options":"{\"timeout\":60}"}},"PolicyUpdatePayload":{"title":"PolicyUpdatePayload","type":"object","properties":{"name":{"type":"string","description":"name","example":"Sample Policy"}},"example":{"name":"Sample Policy"}},"Policysetting":{"title":"Mediatype identifier: policysetting; view=default","type":"object","properties":{"checktype_name":{"type":"string","description":"Check Type Name","example":"vulcan-tls"},"id":{"type":"string","description":"Policy ID","example":"5e51174d-3755-48b2-98bf-37e37cb07f6e"},"options":{"type":"string","description":"options","example":"{\"timeout\":60}"}},"description":"Policy Setting (default view)","example":{"checktype_name":"vulcan-tls","id":"5e51174d-3755-48b2-98bf-37e37cb07f6e","options":"{\"timeout\":60}"}},"PolicysettingCollection":{"title":"Mediatype identifier: policysetting; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Policysetting"},"description":"PolicysettingCollection is the media type for an array of Policysetting (default view)","example":[{"checktype_name":"vulcan-tls","id":"5e51174d-3755-48b2-98bf-37e37cb07f6e","options":"{\"timeout\":60}"}]},"Program":{"title":"Mediatype identifier: program; view=default","type":"object","properties":{"autosend":{"type":"boolean","description":"Autosend","example":true},"disabled":{"type":"boolean","description":"Disabled","example":true},"global":{"type":"boolean","description":"Global","example":false},"id":{"type":"string","description":"Program ID","example":"9a100645-e51a-4e71-8a4f-1e462ce9a40d"},"name":{"type":"string","description":"Name","example":"Every midnight"},"policy_groups":{"type":"array","items":{"$ref":"#/definitions/Program_policy_group"},"description":"PolicyGroup","example":[{"group":{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},"policy":{"id":"af36818a-0f30-412c-9692-d37716075861","name":"Sample Policy","settings_count":12}}]},"schedule":{"$ref":"#/definitions/Schedule"}},"description":"Program (default view)","example":{"autosend":true,"disabled":true,"global":false,"id":"9a100645-e51a-4e71-8a4f-1e462ce9a40d","name":"Every midnight","policy_groups":[{"group":{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},"policy":{"id":"af36818a-0f30-412c-9692-d37716075861","name":"Sample Policy","settings_count":12}}],"schedule":{"cron":"0 7 1 * *"}}},"ProgramCollection":{"title":"Mediatype identifier: program; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Program"},"description":"ProgramCollection is the media type for an array of Program (default view)","example":[{"autosend":true,"disabled":true,"global":false,"id":"9a100645-e51a-4e71-8a4f-1e462ce9a40d","name":"Every midnight","policy_groups":[{"group":{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},"policy":{"id":"af36818a-0f30-412c-9692-d37716075861","name":"Sample Policy","settings_count":12}}],"schedule":{"cron":"0 7 1 * *"}}]},"ProgramPayload":{"title":"ProgramPayload","type":"object","properties":{"autosend":{"type":"boolean","description":"Autosend","example":false},"disabled":{"type":"boolean","description":"Disabled","example":true},"name":{"type":"string","description":"name","example":"Every midnight"},"policy_groups":{"type":"array","items":{"$ref":"#/definitions/ProgramPolicyGroupPayload"},"description":"PolicyGroups","example":[{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."},{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."},{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."}]}},"example":{"autosend":false,"disabled":true,"name":"Every midnight","policy_groups":[{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."},{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."},{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."}]}},"ProgramPolicyGroupPayload":{"title":"ProgramPolicyGroupPayload","type":"object","properties":{"group_id":{"type":"string","description":"group","example":"Non consequatur perferendis dolor laboriosam."},"policy_id":{"type":"string","description":"policy","example":"Distinctio quis ipsam ducimus sit odio tenetur."}},"example":{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."}},"ProgramUpdatePayload":{"title":"ProgramUpdatePayload","type":"object","properties":{"autosend":{"type":"boolean","description":"Autosend","example":true},"disabled":{"type":"boolean","description":"Disabled","example":true},"name":{"type":"string","description":"name","example":"Every midnight"},"policy_groups":{"type":"array","items":{"$ref":"#/definitions/ProgramPolicyGroupPayload"},"description":"PolicyGroups","example":[{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."},{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."},{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."}]}},"example":{"autosend":true,"disabled":true,"name":"Every midnight","policy_groups":[{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."},{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."},{"group_id":"Non consequatur perferendis dolor laboriosam.","policy_id":"Distinctio quis ipsam ducimus sit odio tenetur."}]}},"Program_policy_group":{"title":"Mediatype identifier: program_policy_group; view=default","type":"object","properties":{"group":{"$ref":"#/definitions/Group"},"policy":{"$ref":"#/definitions/Policy"}},"description":"Program_policy_group media type (default view)","example":{"group":{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},"policy":{"id":"af36818a-0f30-412c-9692-d37716075861","name":"Sample Policy","settings_count":12}}},"Recipient":{"title":"Mediatype identifier: recipient; view=default","type":"object","properties":{"email":{"type":"string","description":"email","example":"john.doe@vulcan.example.com"}},"description":"Recipient (default view)","example":{"email":"john.doe@vulcan.example.com"}},"RecipientCollection":{"title":"Mediatype identifier: recipient; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Recipient"},"description":"RecipientCollection is the media type for an array of Recipient (default view)","example":[{"email":"john.doe@vulcan.example.com"},{"email":"john.doe@vulcan.example.com"},{"email":"john.doe@vulcan.example.com"}]},"RecipientsPayload":{"title":"RecipientsPayload","type":"object","properties":{"emails":{"type":"array","items":{"type":"string","example":"Esse velit molestias debitis ullam et."},"description":"Emails","example":["john.doe@vulcan.example.com","jane.doe@vulcan.example.com"]}},"example":{"emails":["john.doe@vulcan.example.com","jane.doe@vulcan.example.com"]},"required":["emails"]},"Resource":{"title":"Mediatype identifier: resource; view=default","type":"object","properties":{"attributes":{"type":"array","items":{"type":"string","example":"Enim totam ut perspiciatis quia."},"description":"attributes of a resource","example":["Hostname","Port"]},"name":{"type":"string","description":"Resource name","example":"Network Resources"},"resources":{"type":"array","items":{"type":"object","example":{"Sed repellat laboriosam repellat eum nihil.":"Magni id et vero in."},"additionalProperties":true},"description":"values for attributes of a resource","example":[{"Hostname":"test.example.com","Port":"443"}]}},"description":"resource (default view)","example":{"attributes":["Hostname","Port"],"name":"Network Resources","resources":[{"Hostname":"test.example.com","Port":"443"}]}},"Scan":{"title":"Mediatype identifier: scan; view=default","type":"object","properties":{"checks_count":{"type":"integer","description":"Checks Count","example":20,"format":"int64"},"end_time":{"type":"string","description":"End Time","example":"2018-09-07T10:40:52Z","format":"date-time"},"id":{"type":"string","description":"Scan ID","example":"23e7034f-8180-4895-8e7f-73f2f7d90631"},"program":{"$ref":"#/definitions/Program"},"progress":{"type":"number","description":"Progress","example":1,"format":"double"},"requested_by":{"type":"string","description":"Requested By","example":"john.doe@vulcan.example.com"},"scheduled_time":{"type":"string","description":"Scheduled Time","example":"2018-09-07T10:40:52Z","format":"date-time"},"start_time":{"type":"string","description":"Start Time","example":"2018-09-07T10:40:52Z","format":"date-time"},"status":{"type":"string","description":"Status","example":"FINISHED"}},"description":"Scan (default view)","example":{"checks_count":20,"end_time":"2018-09-07T10:40:52Z","id":"23e7034f-8180-4895-8e7f-73f2f7d90631","program":{"autosend":true,"disabled":true,"global":false,"id":"9a100645-e51a-4e71-8a4f-1e462ce9a40d","name":"Every midnight","policy_groups":[{"group":{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},"policy":{"id":"af36818a-0f30-412c-9692-d37716075861","name":"Sample Policy","settings_count":12}}],"schedule":{"cron":"0 7 1 * *"}},"progress":1,"requested_by":"john.doe@vulcan.example.com","scheduled_time":"2018-09-07T10:40:52Z","start_time":"2018-09-07T10:40:52Z","status":"FINISHED"}},"ScanCollection":{"title":"Mediatype identifier: scan; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Scan"},"description":"ScanCollection is the media type for an array of Scan (default view)","example":[{"checks_count":20,"end_time":"2018-09-07T10:40:52Z","id":"23e7034f-8180-4895-8e7f-73f2f7d90631","program":{"autosend":true,"disabled":true,"global":false,"id":"9a100645-e51a-4e71-8a4f-1e462ce9a40d","name":"Every midnight","policy_groups":[{"group":{"assets_count":1,"description":"All newly created assets are added to the Default group","id":"f6360346-77a5-4f97-b919-331363b3af26","name":"Default group","options":"{\"timeout\":60}"},"policy":{"id":"af36818a-0f30-412c-9692-d37716075861","name":"Sample Policy","settings_count":12}}],"schedule":{"cron":"0 7 1 * *"}},"progress":1,"requested_by":"john.doe@vulcan.example.com","scheduled_time":"2018-09-07T10:40:52Z","start_time":"2018-09-07T10:40:52Z","status":"FINISHED"}]},"ScanPayload":{"title":"ScanPayload","type":"object","properties":{"program_id":{"type":"string","description":"Program ID","example":"1bb4c953-245e-477b-b005-400f319274f2"},"scheduled_time":{"type":"string","description":"Group ID","example":"2018-09-07T10:40:52Z","format":"date-time"}},"example":{"program_id":"1bb4c953-245e-477b-b005-400f319274f2","scheduled_time":"2018-09-07T10:40:52Z"},"required":["program_id"]},"Schedule":{"title":"Mediatype identifier: schedule; view=default","type":"object","properties":{"cron":{"type":"string","description":"Cron Expression","example":"0 7 1 * *"}},"description":"Schedule (default view)","example":{"cron":"0 7 1 * *"},"required":["cron"]},"SchedulePayload":{"title":"SchedulePayload","type":"object","properties":{"cron":{"type":"string","description":"Cron Expression","example":"0 7 1 * *"}},"example":{"cron":"0 7 1 * *"}},"ScheduleUpdatePayload":{"title":"ScheduleUpdatePayload","type":"object","properties":{"cron":{"type":"string","description":"Cron Expression","example":"0 7 1 * *"}},"example":{"cron":"0 7 1 * *"}},"Source":{"title":"Mediatype identifier: source; view=default","type":"object","properties":{"component":{"type":"string","description":"Source component","example":"vulcan-tls"},"id":{"type":"string","description":"Source ID","example":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4"},"instance":{"type":"string","description":"Source instance ID","example":"b3320f03-1284-42fd-9cf4-5bb6c500966f"},"name":{"type":"string","description":"Source name","example":"vulcan"},"options":{"type":"string","description":"Source options","example":"{\"timeout\":60}"},"time":{"type":"string","description":"Source execution end time","example":"2019-06-08 11:16:40"}},"description":"source (default view)","example":{"component":"vulcan-tls","id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","instance":"b3320f03-1284-42fd-9cf4-5bb6c500966f","name":"vulcan","options":"{\"timeout\":60}","time":"2019-06-08 11:16:40"}},"Stats":{"title":"Mediatype identifier: stats; view=default","type":"object","properties":{"critical":{"type":"number","description":"Stats for critical vulnerabilities","example":0.2903626580923911,"format":"double"},"high":{"type":"number","description":"Stats for high vulnerabilities","example":0.12127770670881338,"format":"double"},"informational":{"type":"number","description":"Stats for informational vulnerabilities","example":0.3701317536253242,"format":"double"},"low":{"type":"number","description":"Stats for low vulnerabilities","example":0.736090529450781,"format":"double"},"medium":{"type":"number","description":"Stats for medium vulnerabilities","example":0.017698863203481317,"format":"double"}},"description":"Stats by severity (default view)","example":{"critical":0.2903626580923911,"high":0.12127770670881338,"informational":0.3701317536253242,"low":0.736090529450781,"medium":0.017698863203481317}},"Statsassets":{"title":"Mediatype identifier: statsassets; view=default","type":"object","properties":{"assets":{"$ref":"#/definitions/Statstotal"}},"description":"Assets by severity stats (default view)","example":{"assets":{"critical":0.3602830379559806,"high":0.6517825863008089,"informational":0.4039820739887437,"low":0.43571544865095874,"medium":0.9513589896198863,"total":0.05810810305338469}}},"Statsaverages":{"title":"Mediatype identifier: statsaverages; view=default","type":"object","properties":{"mean":{"type":"number","description":"Mean of the stats","example":0.11209448947762005,"format":"double"},"percentile_10":{"type":"number","description":"Percentile 10 of the stats","example":0.5075172645112574,"format":"double"},"percentile_25":{"type":"number","description":"Percentile 25 of the stats","example":0.5429089680729741,"format":"double"},"percentile_50":{"type":"number","description":"Percentile 50 or median of the stats","example":0.985214296805186,"format":"double"},"percentile_75":{"type":"number","description":"Percentile 75 or third quartile of the stats","example":0.3678803730882772,"format":"double"},"percentile_90":{"type":"number","description":"Percentile 90 of the stats","example":0.7278236287555608,"format":"double"}},"description":"Stats by different averages (default view)","example":{"mean":0.11209448947762005,"percentile_10":0.5075172645112574,"percentile_25":0.5429089680729741,"percentile_50":0.985214296805186,"percentile_75":0.3678803730882772,"percentile_90":0.7278236287555608}},"Statscoverage":{"title":"Mediatype identifier: statscoverage; view=default","type":"object","properties":{"coverage":{"type":"number","description":"Percentage of assets confirmed respect to discovered","example":0.8065503820569375,"format":"double"}},"description":"Asset Coverage: discovered vs. confirmed (default view)","example":{"coverage":0.8065503820569375}},"Statsfixed":{"title":"Mediatype identifier: statsfixed; view=default","type":"object","properties":{"fixed_issues":{"$ref":"#/definitions/Stats"}},"description":"Fixed issues stats (default view)","example":{"fixed_issues":{"critical":0.2903626580923911,"high":0.12127770670881338,"informational":0.3701317536253242,"low":0.736090529450781,"medium":0.017698863203481317}}},"Statsopen":{"title":"Mediatype identifier: statsopen; view=default","type":"object","properties":{"open_issues":{"$ref":"#/definitions/Stats"}},"description":"Open issues stats (default view)","example":{"open_issues":{"critical":0.2903626580923911,"high":0.12127770670881338,"informational":0.3701317536253242,"low":0.736090529450781,"medium":0.017698863203481317}}},"Statstotal":{"title":"Mediatype identifier: statstotal; view=default","type":"object","properties":{"critical":{"type":"number","description":"Stats for critical vulnerabilities","example":0.3602830379559806,"format":"double"},"high":{"type":"number","description":"Stats for high vulnerabilities","example":0.6517825863008089,"format":"double"},"informational":{"type":"number","description":"Stats for informational vulnerabilities","example":0.4039820739887437,"format":"double"},"low":{"type":"number","description":"Stats for low vulnerabilities","example":0.43571544865095874,"format":"double"},"medium":{"type":"number","description":"Stats for medium vulnerabilities","example":0.9513589896198863,"format":"double"},"total":{"type":"number","description":"Stats for all vulnerabilities","example":0.05810810305338469,"format":"double"}},"description":"Stats by severity (default view)","example":{"critical":0.3602830379559806,"high":0.6517825863008089,"informational":0.4039820739887437,"low":0.43571544865095874,"medium":0.9513589896198863,"total":0.05810810305338469}},"Target":{"title":"Mediatype identifier: target; view=default","type":"object","properties":{"id":{"type":"string","description":"Target ID","example":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4"},"identifier":{"type":"string","description":"Target identifier","example":"www.test.com"},"teams":{"type":"array","items":{"type":"string","example":"Velit quis."},"description":"List of TeamIDs associated with target","example":["a9d33628-ddb0-467c-b482-474887097820","9cb0bb2b-ca36-4877-acad-9dde23880595"]}},"description":"target (default view)","example":{"id":"f8129c7f-7abf-41ba-ab1f-c97090bb3db4","identifier":"www.test.com","teams":["a9d33628-ddb0-467c-b482-474887097820","9cb0bb2b-ca36-4877-acad-9dde23880595"]}},"Team":{"title":"Mediatype identifier: team; view=default","type":"object","properties":{"description":{"type":"string","description":"Description","example":"Security Team"},"id":{"type":"string","description":"Team ID","example":"ff74a33c-e683-4612-a62f-a9cf385f6522"},"name":{"type":"string","description":"Name","example":"Security"},"tag":{"type":"string","description":"tag","example":"team:security"},"using_tracker":{"type":"boolean","description":"If the team is Onboarded in Vulcan Tracker","example":true}},"description":"Team (default view)","example":{"description":"Security Team","id":"ff74a33c-e683-4612-a62f-a9cf385f6522","name":"Security","tag":"team:security","using_tracker":true}},"TeamCollection":{"title":"Mediatype identifier: team; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Team"},"description":"TeamCollection is the media type for an array of Team (default view)","example":[{"description":"Security Team","id":"ff74a33c-e683-4612-a62f-a9cf385f6522","name":"Security","tag":"team:security","using_tracker":true},{"description":"Security Team","id":"ff74a33c-e683-4612-a62f-a9cf385f6522","name":"Security","tag":"team:security","using_tracker":true},{"description":"Security Team","id":"ff74a33c-e683-4612-a62f-a9cf385f6522","name":"Security","tag":"team:security","using_tracker":true}]},"TeamMemberPayload":{"title":"TeamMemberPayload","type":"object","properties":{"email":{"type":"string","description":"Email","example":"john.doe@vulcan.example.com"},"role":{"type":"string","description":"Member role. Valid values are: owner, member","example":"owner"},"user_id":{"type":"string","description":"User ID","example":"967d9966-b561-4233-bd6f-cac603fd8320"}},"example":{"email":"john.doe@vulcan.example.com","role":"owner","user_id":"967d9966-b561-4233-bd6f-cac603fd8320"}},"TeamMemberUpdatePayload":{"title":"TeamMemberUpdatePayload","type":"object","properties":{"role":{"type":"string","description":"Member role. Valid values are: owner, member","example":"owner"}},"example":{"role":"owner"}},"TeamPayload":{"title":"TeamPayload","type":"object","properties":{"description":{"type":"string","description":"description","example":"Security Team"},"name":{"type":"string","description":"name","example":"Security"},"tag":{"type":"string","description":"tag","example":"team:security"}},"example":{"description":"Security Team","name":"Security","tag":"team:security"},"required":["name","tag"]},"TeamUpdatePayload":{"title":"TeamUpdatePayload","type":"object","properties":{"description":{"type":"string","description":"description","example":"Security Team"},"name":{"type":"string","description":"name","example":"Security"},"tag":{"type":"string","description":"tag","example":"team:security"}},"example":{"description":"Security Team","name":"Security","tag":"team:security"}},"Teammember":{"title":"Mediatype identifier: teammember; view=default","type":"object","properties":{"role":{"type":"string","description":"Role","example":"owner"},"user":{"$ref":"#/definitions/User"}},"description":"Team Member (default view)","example":{"role":"owner","user":{"active":true,"admin":true,"email":"john.doe@vulcan.example.com","firstname":"John","id":"967d9966-b561-4233-bd6f-cac603fd8320","last_login":"2018-09-07T10:40:52Z","lastname":"Doe","observer":true}}},"TeammemberCollection":{"title":"Mediatype identifier: teammember; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/Teammember"},"description":"TeammemberCollection is the media type for an array of Teammember (default view)","example":[{"role":"owner","user":{"active":true,"admin":true,"email":"john.doe@vulcan.example.com","firstname":"John","id":"967d9966-b561-4233-bd6f-cac603fd8320","last_login":"2018-09-07T10:40:52Z","lastname":"Doe","observer":true}},{"role":"owner","user":{"active":true,"admin":true,"email":"john.doe@vulcan.example.com","firstname":"John","id":"967d9966-b561-4233-bd6f-cac603fd8320","last_login":"2018-09-07T10:40:52Z","lastname":"Doe","observer":true}},{"role":"owner","user":{"active":true,"admin":true,"email":"john.doe@vulcan.example.com","firstname":"John","id":"967d9966-b561-4233-bd6f-cac603fd8320","last_login":"2018-09-07T10:40:52Z","lastname":"Doe","observer":true}}]},"Token":{"title":"Mediatype identifier: token; view=default","type":"object","properties":{"creation_time":{"type":"string","description":"Creation time","example":"2018-09-07T10:40:52Z"},"email":{"type":"string","description":"Email","example":"john.doe@vulcan.example.com"},"hash":{"type":"string","description":"Hash","example":"903af1a77ea4eda46b60d85fac0f312ff9d3b6ea092434c8a6ef1868bf95da77"},"token":{"type":"string","description":"Token","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MzcxODQ0NjksInN1YiI6Im1haWNvbkBjb3N0YS5jb20iLCJ0eXBlIjoiQVBJIn0.zu8mf5nSpvmFyZNZM7Im-omHa_J9Ck1KH49zuy1wvjY"}},"description":"Token (default view)","example":{"creation_time":"2018-09-07T10:40:52Z","email":"john.doe@vulcan.example.com","hash":"903af1a77ea4eda46b60d85fac0f312ff9d3b6ea092434c8a6ef1868bf95da77","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MzcxODQ0NjksInN1YiI6Im1haWNvbkBjb3N0YS5jb20iLCJ0eXBlIjoiQVBJIn0.zu8mf5nSpvmFyZNZM7Im-omHa_J9Ck1KH49zuy1wvjY"}},"User":{"title":"Mediatype identifier: user; view=default","type":"object","properties":{"active":{"type":"boolean","description":"Active","example":true},"admin":{"type":"boolean","description":"Admin","example":true},"email":{"type":"string","description":"Email","example":"john.doe@vulcan.example.com"},"firstname":{"type":"string","description":"First name","example":"John"},"id":{"type":"string","description":"User ID","example":"967d9966-b561-4233-bd6f-cac603fd8320"},"last_login":{"type":"string","description":"last_login","example":"2018-09-07T10:40:52Z","format":"date-time"},"lastname":{"type":"string","description":"Last name","example":"Doe"},"observer":{"type":"boolean","description":"Observer","example":true}},"description":"User (default view)","example":{"active":true,"admin":true,"email":"john.doe@vulcan.example.com","firstname":"John","id":"967d9966-b561-4233-bd6f-cac603fd8320","last_login":"2018-09-07T10:40:52Z","lastname":"Doe","observer":true}},"UserCollection":{"title":"Mediatype identifier: user; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/User"},"description":"UserCollection is the media type for an array of User (default view)","example":[{"active":true,"admin":true,"email":"john.doe@vulcan.example.com","firstname":"John","id":"967d9966-b561-4233-bd6f-cac603fd8320","last_login":"2018-09-07T10:40:52Z","lastname":"Doe","observer":true}]},"UserPayload":{"title":"UserPayload","type":"object","properties":{"active":{"type":"boolean","description":"Active (Default: true)","example":true},"admin":{"type":"boolean","description":"Admin","default":false,"example":false},"email":{"type":"string","description":"Email","example":"john.doe@vulcan.example.com"},"firstname":{"type":"string","description":"First Name","example":"John"},"lastname":{"type":"string","description":"Last Name","example":"Doe"},"observer":{"type":"boolean","description":"Observer","default":false,"example":false}},"example":{"active":true,"admin":false,"email":"john.doe@vulcan.example.com","firstname":"John","lastname":"Doe","observer":false},"required":["email"]},"UserUpdatePayload":{"title":"UserUpdatePayload","type":"object","properties":{"active":{"type":"boolean","description":"Active (Default: true)","example":true},"admin":{"type":"boolean","description":"Admin","default":false,"example":false},"firstname":{"type":"string","description":"First Name","example":"John"},"lastname":{"type":"string","description":"Last Name","example":"Doe"}},"example":{"active":true,"admin":false,"firstname":"John","lastname":"Doe"}}},"responses":{"OK":{"description":"OK"}},"securityDefinitions":{"Bearer":{"type":"apiKey","name":"authorization","in":"header"}}}