Davis security advisor API
The Davis Security Advisor API lists Davis recommendations related to open and unmuted security problems.
You can limit the output by using the pagination:
- Specify the number of results per page in the pageSize query parameter.
- Then use the cursor from the nextPageKey field of the previous response in the nextPageKey query parameter to obtain subsequent pages.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/davis/securityAdvices |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/davis/securityAdvices | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/davis/securityAdvices |
Authentication
To execute this request, you need an access token with securityProblems.read scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| managementZoneFilter | string | To specify management zones, use one of the options listed below. For each option you can specify multiple comma-separated values. If several values are specified, the OR logic applies. All values are case-sensitive and must be quoted.
You can specify several comma-separated criteria (for example, | query | optional |
| nextPageKey | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters. | query | optional |
| pageSize | integer | The amount of security advices in a single response payload. The maximal allowed page size is 500. If not set, 5 is used. | query | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Davis | Success |
Response body objects
The DavisSecurityAdviceList object
A list of advice from the Davis security advisor.
| Element | Type | Description |
|---|---|---|
| totalCount | integer | The total number of entries in the result. |
| pageSize | integer | The number of entries per page. |
| nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
| advices | Davis | - |
The DavisSecurityAdvice object
Security advice from the Davis security advisor.
| Element | Type | Description |
|---|---|---|
| name | string | The name of the advice. |
| vulnerableComponent | string | The vulnerable component to which advice applies. |
| technology | string | The technology of the vulnerable component. |
| adviceType | string | The type of the advice. |
| critical | string[] | IDs of |
| high | string[] | IDs of |
| medium | string[] | IDs of |
| low | string[] | IDs of |
| none | string[] | IDs of |
Response body JSON model
{
"totalCount": 1,
"pageSize": 1,
"nextPageKey": "AQAAABQBAAAABQ==",
"advices": [
{
"name": "string",
"vulnerableComponent": "string",
"technology": "DOTNET",
"adviceType": "UPGRADE",
"critical": [
"string"
],
"high": [
"string"
],
"medium": [
"string"
],
"low": [
"string"
],
"none": [
"string"
]
}
]
}