Parameter | Type | Explanation | Example Value |
---|---|---|---|
Authorization* | Header | Authorization has a service token | 74h5cR8sETSJRvOFkdbsISY3lsgfNGu_V5aNur4Pxu1Jh8kP0NQBJhuWQsRmGzTX |
vulscan * | BODY | Scan Data in Json | { "endpoint_hostname": "string", "provider_href": "string", "scannedby": "string", "scanned_time": "string", "technical_service": "string", "technical_service_tag": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "technicalserviceoverride": true, "vulnerabilities": [ { "actions": [ "string" ], "attr": { "jira-issue-key": "string" }, "author": "string", "closeDate": "string", "comments": [ { "createdAt": "string", "htmlText": "string", "key": "string", "login": "string", "markdown": "string", "updatable": true } ], "component": "string", "creationDate": "string", "debt": "string", "effort": "string", "hash": "string", "key": "string", "line": 0, "message": "string", "project": "string", "resolution": "string", "rule": "string", "severity": "string", "status": "string", "tags": [ "string" ], "textRange": { "endLine": 0, "endOffset": 0, "startLine": 0, "startOffset": 0 }, "transitions": [ "string" ], "type": "string", "updateDate": "string" } ], "vulnerability_density": 0 } |
curl -X 'POST' \ 'dash/api/dev_secops/v3/technical-services/static-scan' \ -H 'accept: application/json' \ -H 'Authorization: Token aJzv1zn_G-XmerycnRhX1uzUGyPZZWvbK-bcRdAZoRs6XzIUnThfLnolc0sTrzoL' \ -H 'Content-Type: application/json' \ -d '{ "endpoint_hostname": "123", "provider_href": "http://mytest.com", "scannedby": "BYO", "scanned_time": "2022-12-05T07:20:50.52Z", "technical_service": "myservice", "technical_service_tag": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "technicalserviceoverride": true, "vulnerabilities": [ { "actions": [ "string" ], "attr": { "jira-issue-key": "string" }, "author": "string", "closeDate": "string", "comments": [ { "createdAt": "string", "htmlText": "string", "key": "string", "login": "string", "markdown": "string", "updatable": true } ], "component": "string", "creationDate": "string", "debt": "string", "effort": "string", "hash": "string", "key": "newkey", "line": 0, "message": "string", "project": "string", "resolution": "string", "rule": "string", "severity": "Critical", "status": "OPEN", "tags": [ "string" ], "textRange": { "endLine": 0, "endOffset": 0, "startLine": 0, "startOffset": 0 }, "transitions": [ "string" ], "type": "string", "updateDate": "string" } ], "vulnerability_density": 0 }'
Field | Data Type | Explanation | Example Value |
---|---|---|---|
endpoint_hostname | string | Name of the endpoints | "myOrg/myRepo" |
provider_href * | string | Provider URL on which vulnerability is scanned | "http://mytest.com |
scannedby * | string | Tool which is used to scan the Vunerabilities of the repositories | "BYO", |
scanned_time * | string | Time of the scan in UTC | "2022-12-05T07:20:50.52Z" technical_service * |
technicalserviceoverride | boolean | Override flag for the service | true |
Vulnerabilities | Details of the fields | ||
Key * | string | Value of the Key | "new_key" |
Severity* | string | Severity of Vulnerability | critical, high, low, medium |
Component | string | Name of the Component | "/var/lib/comp" |
Project | string | Name of the Project | "DI-SecOps" |
Rule | string | Rule Name | unused variable |
Line | int32 | Line number | 124 |
Hash | string | Hash value | d94d76ad5f5cecd413e |
Resolution | string | Reason of remediation | resolved |
Status * | string | Status of the Vulnerability | OPEN, CONFIRMED, REOPEND |
Message | string | Details of the Vulnerability | "This is created for BYO" |
Effort | string | Time taken to resolve | 30 min |
Debt | string | ||
Author | string | Name of the Author | Alice |
Tags | []string | Tages for the vulnerability | unused |
CreationDate | string | Date of creation | "2022-12-05T07:20:50.52Z" |
UpdateDate | string | Date of update | "2022-12-05T07:20:50.52Z" |
CloseDate | string | Date of close | "2022-12-05T07:20:50.52Z" |
Type | string | Type of Vulnerability | internal |
TextRange | string | Range of texts | |
Comments | string | Comments on the vulnerability | "Created for the internal services" |
Attr | []string | Attributes | |
Transitions | string | transitions | |
Actions | string | Actions taken |