Notifications

This documentation is currently outdated and in the process of being updated. This documentation is provided as a temporary reference to various API endpoints and output. This warning will be at the top of each outdated page. As the documentation is updated, this warning will be removed.

Notifications provide users an alert that guides them to a page showing the related information for the subscribed event. Users can customize the desired level of notifications that are important to them. The Ivanti Neurons platform is processing new data inputs daily, which may include new vulnerability scans, newly published vulnerabilities, and increases to the VRR or severity scoring of existing vulnerabilities as new threats are published. The new Notifications feature will enable the users to have more acute awareness so that they can easily maintain a robust vulnerability management program.

List All Templates for a User

List all notification templates for a user.

API Call: GET/client/{clientId}/rsNotifications/rules

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/rules

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to List all notification templates for a user are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Subscribe to Notification

Subscribe to notifications.

API Call: PUT/client/{clientId}/rsNotifications/rules

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/rules

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to subscribe to notifications are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Mark Notifications as Read/Unread

Mark notifications as read/unread.

API Call: GET/client/{clientId}/rsNotifications/mark-as-read

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/mark-as-read

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to mark notifications as read/unread are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Create a Delivery Channel

Create a delivery channel.

API Call: POST/client/{clientId}/rsNotifications/channel

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/channel

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to create a delivery channel are:

  • Notification Modify

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Edit a Delivery Channel

Edit a delivery channel.

API Call: PUT/client/{clientId}/rsNotifications/channel

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/channel

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to Edit a delivery channel are:

  • Notification Modify

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Delete a Delivery Channel

Delete a delivery channel.

API Call: DELETE/client/{clientId}/rsNotifications/channel

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/channel

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to delete a delivery channel are:

  • Notification Modify

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List All Channels for a User

List all channels for a user.

API Call: GET/client/{clientId}/rsNotifications/channel/{order}

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/channel/{order}

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID
ORDER

Required Privileges

The privileges required to list all channels for a user are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Get Verification Code

Get verification code.

API Call: GET/client/{clientId}/rsNotifications/sendverificationcode

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/sendverificationcode

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to Get Verification Code are:

  • Notification Modify

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List Projections and Their Models

List projections and their models.

API Call: GET/client/{clientId}/rsNotifications/model

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/model

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to list projections and their models are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List Filterable Fields for the Search Endpoint

List filterable fields for the search endpoint.

API Call: GET/client/{clientId}/rsNotifications/filter

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/filter

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to list filterable fields for the search endpoint are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Search for Notifications

Search for notifications.

API Call: POST/client/{clientId}/rsNotifications/search

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/search

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to search for notifications are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List Filterable Fields for Search Endpoint

List all notification templates for a user.

API Call: GET/client/{clientId}/rsNotifications/rules

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/rules

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to List all notification templates for a user are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List All Templates for a User

List all notification templates for a user.

API Call: GET/client/{clientId}/rsNotifications/rules

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/rules

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to List all notification templates for a user are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List All Templates for a User

List all notification templates for a user.

API Call: GET/client/{clientId}/rsNotifications/rules

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/rules

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to List all notification templates for a user are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List All Templates for a User

List all notification templates for a user.

API Call: GET/client/{clientId}/rsNotifications/rules

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/rules

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to List all notification templates for a user are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List All Templates for a User

List all notification templates for a user.

API Call: GET/client/{clientId}/rsNotifications/rules

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/rules

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to List all notification templates for a user are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found

List All Templates for a User

List all notification templates for a user.

API Call: GET/client/{clientId}/rsNotifications/rules

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/rsNotifications/rules

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to List all notification templates for a user are:

  • Core Read

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.

cURL

cURL Sample rs3_trend Snippet

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token
STARTDATE First date in range. string($date) Y Format: YYYY-MM-DD.
ENDDATE Last date in range. string($date) Y Format: YYYY-MM-DD.
GROUPID Group ID number. integer Y Searching for a Group Separate group IDs with commas.

Response Parameters

Sample Response

Name Description Type Additional Information
RS3 RiskSense Security Score (RS3) for that day. integer
RISKACCEPTEDRS3 Risk accepted RS3 for that day. integer

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Code Description
400 Bad Request
401 Unauthorized
404 Not Found