Projects
Project overview
Asset and vulnerability counts, weekly new vulnerabilities, last run and recent activity.
GET
/
api
/
projects
/
{id}
/
overview
Project overview
curl --request GET \
--url https://{baseUrl}/api/v1/api/projects/{id}/overviewimport requests
url = "https://{baseUrl}/api/v1/api/projects/{id}/overview"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{baseUrl}/api/v1/api/projects/{id}/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{baseUrl}/api/v1/api/projects/{id}/overview"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"totalAssets": 123,
"newAssets": 123,
"workflows": 123,
"openVulnerabilities": {
"critical": 123,
"high": 123,
"medium": 123,
"low": 123,
"info": 123
},
"newVulnerabilities": 123,
"newVulnerabilityRuns": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"workflowName": "<string>",
"status": "pending",
"jobRunType": "manual"
}
],
"weekly": [
{
"week": "<string>",
"critical": 123,
"high": 123,
"medium": 123,
"low": 123,
"info": 123
}
],
"activity": [
{
"kind": "run",
"at": "2023-11-07T05:31:56Z",
"ref": "<string>",
"change": "settings",
"added": 123,
"removed": 123,
"count": 123,
"reason": "false_positive",
"runStatus": "<string>",
"workflowName": "<string>",
"jobRunType": "<string>",
"newVulnerabilities": 123,
"recurringVulnerabilities": 123,
"scopeSize": 123,
"actorName": "<string>",
"changes": {}
}
],
"lastRun": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"workflowName": "<string>",
"status": "pending",
"jobRunType": "manual"
}
}Response
200 - application/json
⌘I
Project overview
curl --request GET \
--url https://{baseUrl}/api/v1/api/projects/{id}/overviewimport requests
url = "https://{baseUrl}/api/v1/api/projects/{id}/overview"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{baseUrl}/api/v1/api/projects/{id}/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{baseUrl}/api/v1/api/projects/{id}/overview"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"totalAssets": 123,
"newAssets": 123,
"workflows": 123,
"openVulnerabilities": {
"critical": 123,
"high": 123,
"medium": 123,
"low": 123,
"info": 123
},
"newVulnerabilities": 123,
"newVulnerabilityRuns": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"workflowName": "<string>",
"status": "pending",
"jobRunType": "manual"
}
],
"weekly": [
{
"week": "<string>",
"critical": 123,
"high": 123,
"medium": 123,
"low": 123,
"info": 123
}
],
"activity": [
{
"kind": "run",
"at": "2023-11-07T05:31:56Z",
"ref": "<string>",
"change": "settings",
"added": 123,
"removed": 123,
"count": 123,
"reason": "false_positive",
"runStatus": "<string>",
"workflowName": "<string>",
"jobRunType": "<string>",
"newVulnerabilities": 123,
"recurringVulnerabilities": 123,
"scopeSize": 123,
"actorName": "<string>",
"changes": {}
}
],
"lastRun": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"workflowName": "<string>",
"status": "pending",
"jobRunType": "manual"
}
}