https://api.bitsighttech.com/ratings/v1/underwriting-guidelines/guideline_guid
Edit an existing underwriting guideline.
Parameters
* Required.
guid
-
* Required.
[Path] Identify the underwriting guideline to edit.
Value: [String] Underwriting guideline unique identifier [
guideline_guid
]. See GET: Underwriting Guidelines. risk_vectors
-
* Required.
[Body] Define the guidelines for each risk vector.
Value: [Array]
"risk_vectors": [ { […] }
risk_vector_slug
-
* Required.
[Body] Identify the risk vector to edit.
Value: [String] The risk vector slug. See risk types.
minimum_grade
-
* Required.
[Body] Set the minimum risk vector grade.
Value: [String]
A
throughF
is_active
-
[Body] Determine if the minimum risk vector grade should be active for comparison.
Value: [Boolean]
-
true
= Risk vector and its minimum grade are active for comparison. -
false
= Risk vector and its minimum grade are not active for comparison.
-
threats
-
[Query] Filter by threats.
Value: [Array] Comma-separated threat unique identifiers [
threat_guid
]. See GET: Underwriting Guidelines. threat_groups
-
[Query] Filter by threat groups.
Value: [Array] Comma-separated threat group unique identifiers [
threat_group_guid
]. See GET: Underwriting Guidelines. infections
-
[Query] Filter by infections.
Value: [Array] Infection IDs.
Example Request
curl 'https://api.bitsighttech.com/ratings/v1/underwriting-guidelines/m521bb61-33c4-42c9-1234-c8194c305db3' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{ "risk_vectors": [ { "risk_vector_slug": "application_security", "minimum_grade": "A", "is_active": "true" } ], "threats": ["a940bb61-33c4-42c9-1234-c8194c305db3", "a940bb61-33c4-42c9-1234-c8194c305db3", …], "threat_groups": ["a940bb61-33c4-42c9-1234-c8194c305db3", "a940bb61-33c4-42c9-1234-c8194c305db3", …], "infections": [135, 214, …] }' --compressed
Status Codes
200 – Okay
- Everything worked as expected.
400 – Bad Request
- This can often be due to missing a required parameter.
401 – No Authentication
- No valid API token was provided.
403 – Unauthorized
- You do not have permission to access this resource.
404 – Not Found
- The specified resource could not be found.
-
August 20, 2024:
threats
&infections
parameters. -
April 9, 2024:
threats
&threat_groups
parameters. - April 28, 2023: Published.
Feedback
0 comments
Please sign in to leave a comment.