Using Risksense API LibraryΒΆ
To begin make sure you provide the system path to the lib package before importing the script example.
>>> sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))), 'lib'))
To use risksense lib package please ensure you import risksense api in your script
>>> import risksense_api as rsapi
To perform usage of the subject functions you must first create an object and use that object
for subject function definitions. Please ensure you should provide the client id either during function definitions or by setting a default client id using the below function set_default_client_id()
>>> self.rs=rs_api.RiskSenseApi(self._rs_platform_url, api_key)
>>> self.rs.set_default_client_id(self.__client_id)
where self._rs_platform_url is the url of the platform and apikey is the user apikey
Now post the risksense object creation, you can use the object self.rs
for using functions in risksense api packages
>>> self.rs.{subjectname}.{functionname}
where
subjectname - The subject module present in the lib package
functionname - The functionname define for that particular subject
- Applications (
risksense_api.__subject.__applications.__applications
) - Application Findings (
risksense_api.__subject.__application_findings.__application_findings
) - Application Url (
risksense_api.__subject.__application_urls.__application_urls
) - Attachments (
risksense_api.__subject.__attachments.__attachments
) - Clients (
risksense_api.__subject.__clients.__clients
) - Finding History (
risksense_api.__subject.__findinghistory.__findinghistory
) - Export (
risksense_api.__subject.__exports.__exports
) - Groupby (
risksense_api.__subject.__groupBy.__groupBy
) - Hosts (
risksense_api.__subject.__hosts.__hosts
) - Host Findings (
risksense_api.__subject.__host_findings.__host_findings
) - Patch (
risksense_api.__subject.__patch.__patch
) - Playbooks (
risksense_api.__subject.__playbooks.__playbooks
) - Rs3 (
risksense_api.__subject.__rs3.__rs3
) - Quickfilters (
risksense_api.__subject.__quickfilters.__quickfilters
) - Sla (
risksense_api.__subject.__sla.__sla
) - Tags (
risksense_api.__subject.__tags.__tags
) - Workflows (
risksense_api.__subject.__workflows.__workflows
) - Assessments (
risksense_api.__subject.__assessments.__assessments
) - Networks (
risksense_api.__subject.__networks.__networks
) - Roles (
risksense_api.__subject.__role.__role
) - Users (
risksense_api.__subject.__users.__users
) - Groups (
risksense_api.__subject.__groups.__groups
) - Vulnerabilities (
risksense_api.__subject.__vulnerabilities.__vulnerabilities
) - Weaknesses (
risksense_api.__subject.__weaknesses.__weaknesses
) - Uploads (
risksense_api.__subject.__uploads.__uploads
) - Notifications (
risksense_api.__subject.__notifications.__notifications
) - Connectors (
risksense_api.__subject.__connectors.__connectors
) - Tickets (
risksense_api.__subject.__ticket.__ticket
)