Skip to main content

getPolicyDetails

This method retrieves all information related to a security policy.

Parameters

Parameter

Type

Optional

Description

policyId

String

No

The ID of the policy to be queried.

Return value

This method returns an Object containing the details of the queried policy:

  • id - the ID of the queried policy

  • name - the name of the queried policy

  • createdBy - the username who created the policy

  • createDate - the date when the policy was created

  • lastModifyDate - the date when the policy was last modified

  • settings - the settings of the policy

  • lastSuccessfulScan, object. Includes the following details:

    • name - the name of the scan.

    • date - the date on which the scan was performed.

Example

Request:

  {
       "params": {
           "policyId" : "55828d66b1a43de92c712345"
       },
       "jsonrpc": "2.0",
       "method": "getPolicyDetails",
       "id": "98409cc1-93cc-415a-9f77-1d4f681000b3"
  }

Response:

  {
      "id": "47519d2d-92e0-4a1f-b06d-aa458e80f610",
      "jsonrpc":"2.0",
      "result": {
           "id": "5583c480b1a43ddc09712345",
           "name": "Test",
           "createdBy": "[email protected]",
           "createDate": "2015-06-19T10:27:59",
           "lastModifyDate": "2015-06-19T10:27:59",
           "settings": {
               ...
           }
       }
  }
In this section: