Get Implicit Rules

Retrieves the implicit rules related to a list of device tree names.

Prerequisite: Run an analysis for the device(s), otherwise no list of implicit rules, and their associated risks exists.

Resource name: /api/v1/implicit-rules/rules

Request Method: GET

Request parameters:

Parameter Type Description

deviceNames

mandatory

array of strings List of device tree names. Use the GET /devices method from the Devices Setup Resource Group to get device display names.

Request example: 

deviceNames=device1,device2

cURL Example:

curl -X 'GET' \

'https://<localhost>/afa/api/v1/implicit-rules/rules?deviceNames=device1,device2' \

-H 'accept: */*'

Status codes:

Code Description
200 List of implicit rules
400 Validation error: Bad request due to invalid input
401 Unauthorized
403 Forbidden
404 Not Found
423 Locked
429 Too Many Requests
500 Internal Server Error
503 Service Unavailable

Response parameters:

Parameter Type Description
content string The content of the implicit rules.

Response example success 200:

Copy 
{
  "content": "Example of implicit rules content"
}

Response example failure 400:

Copy 
{
  "description": "Invalid input",
  "error": "Validation error",
  "fieldErrors": [
    {
      "field": "deviceNames",
      "error": "Device name is missing or invalid"
    }
  ]
}