Bulk Update Account's Findings

POST 
/findings/bulk/update/

Request

application/json

Body

required

ids string[]required

List of object IDs.

labels

object[]

Labels of the vulnerability finding.

Array [

name stringrequired

Possible values: <= 255 characters

Name of the label.
The maximum length is 255 characters.

color string

Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.

]

definition stringrequired

Definition of the vulnerability.

assignee stringnullable

User who is assigned to fix the vulnerability.

state string
Possible values: [notfixed, invalid, accepted, fixed]
State of the vulnerability finding:
(Read more about the meaning of vulnerability findings states)
• notfixed - Not Fixed
• invalid - Invalid
• accepted - Accepted
• fixed - Fixed
severity integer
Possible values: >= -2147483648 and <= 2147483647, [10, 20, 30, 40]
Severity of the vulnerability finding:
• 10 - low
• 20 - medium
• 30 - high
• 40 - critical
last_found date-time

Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302"

new booleanrequired

If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans.

review_status string
Possible values: [notrequired, pending, rejected, accepted, ``]
Some findings we're unsure are valid and need a manual validation step.
• notrequired - not required
• pending - pending review
• rejected - rejected after review
• accepted - accepted after review
review_reason string

User's reason for finding's review.

comment stringnullable

Comment on the object.

change_reason string

Possible values: <= 4096 characters

Reason for changing the Finding state to 'invalid' or 'accepted'.

expiration_date datenullable

Expiration date of the acceptance. Required if the account setting 'Require expiration date on acceptance' is set.

approver_name string

Name of the person or entity approving the acceptance. Required if the account setting 'Require approval name on acceptance' is set.

approval_date datenullable

Date of the approval of the acceptance. Required if the account setting 'Require approval date on acceptance' is set.

application/x-www-form-urlencoded

Body

required

ids string[]required

List of object IDs.

labels

object[]

Labels of the vulnerability finding.

Array [

name stringrequired

Possible values: <= 255 characters

Name of the label.
The maximum length is 255 characters.

color string

Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.

]

definition stringrequired

Definition of the vulnerability.

assignee stringnullable

User who is assigned to fix the vulnerability.

state string
Possible values: [notfixed, invalid, accepted, fixed]
State of the vulnerability finding:
(Read more about the meaning of vulnerability findings states)
• notfixed - Not Fixed
• invalid - Invalid
• accepted - Accepted
• fixed - Fixed
severity integer
Possible values: >= -2147483648 and <= 2147483647, [10, 20, 30, 40]
Severity of the vulnerability finding:
• 10 - low
• 20 - medium
• 30 - high
• 40 - critical
last_found date-time

Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302"

new booleanrequired

If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans.

review_status string
Possible values: [notrequired, pending, rejected, accepted, ``]
Some findings we're unsure are valid and need a manual validation step.
• notrequired - not required
• pending - pending review
• rejected - rejected after review
• accepted - accepted after review
review_reason string

User's reason for finding's review.

comment stringnullable

Comment on the object.

change_reason string

Possible values: <= 4096 characters

Reason for changing the Finding state to 'invalid' or 'accepted'.

expiration_date datenullable

Expiration date of the acceptance. Required if the account setting 'Require expiration date on acceptance' is set.

approver_name string

Name of the person or entity approving the acceptance. Required if the account setting 'Require approval name on acceptance' is set.

approval_date datenullable

Date of the approval of the acceptance. Required if the account setting 'Require approval date on acceptance' is set.

multipart/form-data

Body

required

ids string[]required

List of object IDs.

labels

object[]

Labels of the vulnerability finding.

Array [

name stringrequired

Possible values: <= 255 characters

Name of the label.
The maximum length is 255 characters.

color string

Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.

]

definition stringrequired

Definition of the vulnerability.

assignee stringnullable

User who is assigned to fix the vulnerability.

state string
Possible values: [notfixed, invalid, accepted, fixed]
State of the vulnerability finding:
(Read more about the meaning of vulnerability findings states)
• notfixed - Not Fixed
• invalid - Invalid
• accepted - Accepted
• fixed - Fixed
severity integer
Possible values: >= -2147483648 and <= 2147483647, [10, 20, 30, 40]
Severity of the vulnerability finding:
• 10 - low
• 20 - medium
• 30 - high
• 40 - critical
last_found date-time

Date and time of when the vulnerability was last found, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302"

new booleanrequired

If true, this is a newly found vulnerability. If false, this vulnerability has been found in previous scans.

review_status string
Possible values: [notrequired, pending, rejected, accepted, ``]
Some findings we're unsure are valid and need a manual validation step.
• notrequired - not required
• pending - pending review
• rejected - rejected after review
• accepted - accepted after review
review_reason string

User's reason for finding's review.

comment stringnullable

Comment on the object.

change_reason string

Possible values: <= 4096 characters

Reason for changing the Finding state to 'invalid' or 'accepted'.

expiration_date datenullable

Expiration date of the acceptance. Required if the account setting 'Require expiration date on acceptance' is set.

approver_name string

Name of the person or entity approving the acceptance. Required if the account setting 'Require approval name on acceptance' is set.

approval_date datenullable

Date of the approval of the acceptance. Required if the account setting 'Require approval date on acceptance' is set.

Responses

200

application/json

Schema

Schema

ids string[]required

List of object IDs.

Example (from schema)

{
  "ids": [
    "string"
  ]
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...