Bulk Update Target's Findings

POST 
/targets/:target_id/findings/bulk/update/

Request

Path Parameters

target_id stringrequired

Identifier of the target.

application/json

Body

required

scans string[]required

Scans that originated the vulnerability finding.

labels object[]required
Array [
name stringrequired
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
color stringrequired
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 objectrequired

id stringrequired

name stringrequired

Possible values: <= 255 characters

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

desc stringnullablerequired

Description of the vulnerability.

insertion_point stringrequired
Possible values: [cookie, parameter, arbitrary_url_param, header, url_folder, url_filename, json_parameter, request_body, multipart_parameter, graphql_parameter, non_standard_parameter, ``]
Insertion point of the parameter:
• cookie - Cookie
• parameter - Parameter
• arbitrary_url_param - Parameter
• header - Header
• url_folder - URL Path
• url_filename - URL Path
• json_parameter - JSON Parameter
• request_body - Request Body
• multipart_parameter - Multipart Parameter
• graphql_parameter - GraphQL Parameter
• non_standard_parameter - Non Standard Parameter
parameter stringrequired

Possible values: <= 1024 characters

Name of the inserted parameter.
The maximum length is 1024 characters.

assignee objectrequired

email emailrequired

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

state stringrequired
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 integerrequired
Possible values: >= -2147483648 and <= 2147483647, [10, 20, 30]
Severity of the vulnerability finding:
• 10 - low
• 20 - medium
• 30 - high
last_found date-timerequired

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.

comment stringnullablerequired

Comment on the object.

application/x-www-form-urlencoded

Body

required

scans string[]required

Scans that originated the vulnerability finding.

labels object[]required
Array [
name stringrequired
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
color stringrequired
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 objectrequired

id stringrequired

name stringrequired

Possible values: <= 255 characters

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

desc stringnullablerequired

Description of the vulnerability.

insertion_point stringrequired
Possible values: [cookie, parameter, arbitrary_url_param, header, url_folder, url_filename, json_parameter, request_body, multipart_parameter, graphql_parameter, non_standard_parameter, ``]
Insertion point of the parameter:
• cookie - Cookie
• parameter - Parameter
• arbitrary_url_param - Parameter
• header - Header
• url_folder - URL Path
• url_filename - URL Path
• json_parameter - JSON Parameter
• request_body - Request Body
• multipart_parameter - Multipart Parameter
• graphql_parameter - GraphQL Parameter
• non_standard_parameter - Non Standard Parameter
parameter stringrequired

Possible values: <= 1024 characters

Name of the inserted parameter.
The maximum length is 1024 characters.

assignee objectrequired

email emailrequired

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

state stringrequired
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 integerrequired
Possible values: >= -2147483648 and <= 2147483647, [10, 20, 30]
Severity of the vulnerability finding:
• 10 - low
• 20 - medium
• 30 - high
last_found date-timerequired

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.

comment stringnullablerequired

Comment on the object.

multipart/form-data

Body

required

scans string[]required

Scans that originated the vulnerability finding.

labels object[]required
Array [
name stringrequired
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
color stringrequired
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 objectrequired

id stringrequired

name stringrequired

Possible values: <= 255 characters

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

desc stringnullablerequired

Description of the vulnerability.

insertion_point stringrequired
Possible values: [cookie, parameter, arbitrary_url_param, header, url_folder, url_filename, json_parameter, request_body, multipart_parameter, graphql_parameter, non_standard_parameter, ``]
Insertion point of the parameter:
• cookie - Cookie
• parameter - Parameter
• arbitrary_url_param - Parameter
• header - Header
• url_folder - URL Path
• url_filename - URL Path
• json_parameter - JSON Parameter
• request_body - Request Body
• multipart_parameter - Multipart Parameter
• graphql_parameter - GraphQL Parameter
• non_standard_parameter - Non Standard Parameter
parameter stringrequired

Possible values: <= 1024 characters

Name of the inserted parameter.
The maximum length is 1024 characters.

assignee objectrequired

email emailrequired

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

state stringrequired
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 integerrequired
Possible values: >= -2147483648 and <= 2147483647, [10, 20, 30]
Severity of the vulnerability finding:
• 10 - low
• 20 - medium
• 30 - high
last_found date-timerequired

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.

comment stringnullablerequired

Comment on the object.

Responses

200

application/json

Schema

Schema

ids string[]required

Example (from schema)

{
  "ids": [
    "<finding id>"
  ]
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

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 stringrequired

Example (from schema)

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

404

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

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

Loading...