PRprobely
Findings

Partial Update Account's Finding

Changed on
patch/findings/{id}/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/findings/{id}/
  • Auth
    API key in header Authorization

Path parameters

idinteger required

A unique integer value identifying this finding.

Request body

idinteger
targetstring

Target scanned to find vulnerabilities.

scansstring[]

Scans that originated the vulnerability finding.

fixstring

Description of how to fix the vulnerability.

evidencestring

Evidence with proof of the vulnerability finding.

extrastring

Extra details about the vulnerability finding.

definitionstring

Definition of the vulnerability.

urlstring

URL of the vulnerability finding. For example, "http://www.example.com/user/show-details". The maximum length is 66000 characters.

pathstring

URL of the vulnerability finding. For example, "https://www.example.com/user/show-details".

method'get' | 'post' | 'trace' | 'options' | 'put' | 'delete'

HTTP method used in the request:

  • get - GET
  • post - POST
  • trace - TRACE
  • options - OPTIONS
  • put - PUT
  • delete - DELETE
insertion_point'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
parameterstring

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

valuestring nullable

Value of the inserted parameter.

operation_namestring

GraphQL operation name, if applicable.

operation_typestring

GraphQL operation type (query, mutation, subscription), if applicable.

paramsobject nullable

Query parameters of the vulnerability finding.

assigneestring nullable

User who is assigned to fix the vulnerability.

state'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
severity10 | 20 | 30 | 40

Severity of the vulnerability finding:

  • 10 - low
  • 20 - medium
  • 30 - high
  • 40 - critical
cvss_scorenumber double nullable

Score of the vulnerability finding according to the Common Vulnerability Scoring System (CVSS).

cvss_vectorstring

Vector with the metrics of the score of the vulnerability finding according to the Common Vulnerability Scoring System (CVSS).

last_foundstring 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"

retestingboolean

If true, the vulnerability will be retested.
If, after the retest, the vulnerability is no longer found, the vulnerability finding is marked as fixed. Otherwise, it is marked as not fixed.

newboolean

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

review_status'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_reasonstring

User's reason for finding's review.

created_atstring date-time nullable

Timestamp of the Finding's creation.

changedstring date-time

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

commentstring nullable

Comment on the object.

change_reasonstring

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

expiration_datestring date nullable

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

approver_namestring

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

approval_datestring date nullable

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

has_sast_correlationsboolean

Response

idinteger required

Unique finding identifier.

scansstring[] required

Scans that originated the vulnerability finding.

fixstring required

Description of how to fix the vulnerability.

evidencestring required

Evidence with proof of the vulnerability finding.

extrastring required

Extra details about the vulnerability finding.

urlstring required

URL of the vulnerability finding. For example, "http://www.example.com/user/show-details". The maximum length is 66000 characters.

pathstring required

URL of the vulnerability finding. For example, "https://www.example.com/user/show-details".

method'get' | 'post' | 'trace' | 'options' | 'put' | 'delete' required

HTTP method used in the request:

  • get - GET
  • post - POST
  • trace - TRACE
  • options - OPTIONS
  • put - PUT
  • delete - DELETE
insertion_point'cookie' | 'parameter' | 'arbitrary_url_param' | 'header' | 'url_folder' | 'url_filename' | 'json_parameter' | 'request_body' | 'multipart_parameter' | 'graphql_parameter' | 'non_standard_parameter' required

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
parameterstring required

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

valuestring nullable required

Value of the inserted parameter.

operation_namestring required

GraphQL operation name, if applicable.

operation_typestring required

GraphQL operation type (query, mutation, subscription), if applicable.

paramsobject nullable required

Query parameters of the vulnerability finding.

state'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
severity10 | 20 | 30 | 40

Severity of the vulnerability finding:

  • 10 - low
  • 20 - medium
  • 30 - high
  • 40 - critical
cvss_scorenumber double nullable required

Score of the vulnerability finding according to the Common Vulnerability Scoring System (CVSS).

cvss_vectorstring required

Vector with the metrics of the score of the vulnerability finding according to the Common Vulnerability Scoring System (CVSS).

last_foundstring date-time required

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

retestingboolean required

If true, the vulnerability will be retested.
If, after the retest, the vulnerability is no longer found, the vulnerability finding is marked as fixed. Otherwise, it is marked as not fixed.

newboolean required

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

review_status'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_reasonstring

User's reason for finding's review.

created_atstring date-time nullable required

Timestamp of the Finding's creation.

changedstring date-time required

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

commentstring nullable

Comment on the object.

change_reasonstring

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

expiration_datestring date nullable

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

approver_namestring

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

approval_datestring date nullable

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

has_sast_correlationsboolean required

Whether this finding has correlated Snyk Code (SAST) findings. Only present for accounts with the Snyk Code (SAST) entitlement.

Changes

  • 0b2f6cbe644dRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from string to integer for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to array for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      added the new bruno enum value to the /////////////// response property for the response status

    • warning

      added the new folder enum value to the /////////////// response property for the response status

    • warning

      added the new interactive_browser enum value to the /////////////// response property for the response status

    • warning

      added the new repository enum value to the /////////////// response property for the response status

    • warning

      added the new zip enum value to the /////////////// response property for the response status

    • info

      the request optional property became read-only (media type: application/json)

    • info

      the request optional property became read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became read-only (media type: multipart/form-data)

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: application/x-www-form-urlencoded)

    • info

      the request property became nullable (media type: multipart/form-data)

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      the response optional property became read-only for the status

    • info

      added the optional write-only property target/allOf[SimpleScope]/site/allOf[Target]/api_scan_settings/allOf[APIScanSettings]/snyk_project_id to the response with the status

    • info

      added the optional write-only property target/allOf[SimpleScope]/site/allOf[Target]/api_scan_settings/allOf[APIScanSettings]/staged_collection_id to the response with the status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ///////////////// to the response with the status

    • info

      added the required property /////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

  • e29879bff01bRevision changes
    • warning

      added the new application/graphql enum value to the /////////////// response property for the response status

    • warning

      added the new graphql enum value to the /////////////// response property for the response status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property ////////// to the response with the status