GET: List RRP Settings

https://api.bitsighttech.com/ratings/v1/companies/company_guid/risk-remediation-plan/settings

List accessible custom RRP settings for the company, grouped by risk vector. Returns shared settings and the requesting user's own private settings, ordered newest first within each vector. See Run a Risk Remediation Plan for details on custom plans.

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/risk-remediation-plan/settings \
  -u api_token:

Example Response

{
  "desktop_software": [],
  "dmarc": [],
  "mobile_software": [
    {
      "guid": "22c85f64-5717-4562-b3fc-2c963f66afa9",
      "name": "Mobile app exclusions",
      "description": "Custom plan for mobile software vector",
      "is_shared": false,
      "user_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2026-04-15T20:35:13.775Z"
    }
  ],
  "patching_cadence": [],
  "ssl_certificates": [],
  "ssl_configurations": [],
  "web_appsec": []
}

Response Attributes

FieldDescription
{risk_vector}[]

Array

List of accessible custom settings for this risk vector. Empty array if none exist.
{risk_vector}[].guid

String [uuid]

Unique identifier for this setting. Use when creating a plan run or updating selections.
{risk_vector}[].name

String

Display name of this setting.
{risk_vector}[].description

String or Null

Optional description of this setting.
{risk_vector}[].is_shared

Boolean

Whether this setting is visible to all users in the company. Private settings are only visible to the creator.
{risk_vector}[].user_guid

String [uuid]

GUID of the user who created this setting.
{risk_vector}[].created_at

String [datetime]

ISO 8601 timestamp of when this setting was created.

Status Codes

200 – Okay

Everything worked as expected.

401 – Unauthorized

No valid API token was provided.

403 – Permission Denied

You do not have permission to access this resource.

422 – Unprocessable Entity

A path parameter value is invalid.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.