Findings
Python SDK reference for the findings resource
Note
The Bevor SDK is coming soon. This page previews its planned Python interface.
Access this resource from client.findings. Both async and sync clients expose the same methods.
list
GET /security/findings
result = await client.findings.list()Arguments:
optionsFindingsQueryParams | Nonequerydefault:
NoneFindingsQueryParams
pageOptional[integer]page_sizeOptional[integer]order_byOptional['created_at' | 'updated_at' | 'level']orderOptional['desc' | 'asc']project_idOptional[string]project_slugOptional[string]user_idOptional[string]is_selfOptional[boolean]code_idOptional[string]analysis_idsOptional[array of string]typeOptional[string]levelOptional['critical' | 'high' | 'medium' | 'low']is_acknowledgedOptional[boolean]created_by_selfOptional[boolean]created_by_user_idOptional[string]operationOptional['add' | 'update' | 'delete' | string]with_paginationboolquerydefault:
FalseReturn type by call:
with_pagination=True→PaginatedResource[FindingSchema]with_pagination=False→Pagination[FindingSchema]
show properties (6)hide properties (6)
resultsarray of FindingSchemashow properties (21)hide properties (21)
versionAnalysisVersionRefrequiredshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredcreated_atstringrequiredorigin_finding_idstringrequiredis_acknowledgedbooleanrequiredtypestringrequiredlevel'critical' | 'high' | 'medium' | 'low'requirednamestringrequiredexplanationstringrequiredrecommendationOptional[string]referenceOptional[string]sourcestringrequiredidstringrequirednode_idstringrequiredis_borrowedbooleanrequiredlocation_idOptional[string]created_by_userUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_slugstringrequiredcode_idstringrequiredoperationOptional['add' | 'update' | 'delete']actionsFindingActionsrequiredshow properties (3)hide properties (3)
can_editbooleanrequiredcan_revertbooleanrequiredcan_deletebooleanrequiredpageintegerrequiredpage_sizeintegerrequiredmorebooleanrequiredtotal_observationsintegerrequiredtotal_pagesintegerrequiredget
GET /security/findings/{finding_id}
result = await client.findings.get(
finding_id=finding_id,
)Arguments:
finding_idIDpathrequiredReturns: FindingSchema
show properties (21)hide properties (21)
versionAnalysisVersionRefrequiredshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredcreated_atstringrequiredorigin_finding_idstringrequiredis_acknowledgedbooleanrequiredtypestringrequiredlevel'critical' | 'high' | 'medium' | 'low'requirednamestringrequiredexplanationstringrequiredrecommendationOptional[string]referenceOptional[string]sourcestringrequiredidstringrequirednode_idstringrequiredis_borrowedbooleanrequiredlocation_idOptional[string]created_by_userUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_slugstringrequiredcode_idstringrequiredoperationOptional['add' | 'update' | 'delete']actionsFindingActionsrequiredshow properties (3)hide properties (3)
can_editbooleanrequiredcan_revertbooleanrequiredcan_deletebooleanrequirededit_metadata
PATCH /security/findings/{finding_id}
result = await client.findings.edit_metadata(
finding_id=finding_id,
body=body,
)Arguments:
finding_idIDpathrequiredbodyEditFindingBodyDictbodyrequiredEditFindingBodyDict
typeOptional[string]levelOptional['critical' | 'high' | 'medium' | 'low']nameOptional[string]explanationOptional[string]recommendationOptional[string]referenceOptional[string]sourceOptional[string]Returns: FindingSchema
show properties (21)hide properties (21)
versionAnalysisVersionRefrequiredshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredcreated_atstringrequiredorigin_finding_idstringrequiredis_acknowledgedbooleanrequiredtypestringrequiredlevel'critical' | 'high' | 'medium' | 'low'requirednamestringrequiredexplanationstringrequiredrecommendationOptional[string]referenceOptional[string]sourcestringrequiredidstringrequirednode_idstringrequiredis_borrowedbooleanrequiredlocation_idOptional[string]created_by_userUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_slugstringrequiredcode_idstringrequiredoperationOptional['add' | 'update' | 'delete']actionsFindingActionsrequiredshow properties (3)hide properties (3)
can_editbooleanrequiredcan_revertbooleanrequiredcan_deletebooleanrequireddelete
DELETE /security/findings/{finding_id}
result = await client.findings.delete(
finding_id=finding_id,
)Arguments:
finding_idIDpathrequiredReturns: FindingSchema
show properties (21)hide properties (21)
versionAnalysisVersionRefrequiredshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredcreated_atstringrequiredorigin_finding_idstringrequiredis_acknowledgedbooleanrequiredtypestringrequiredlevel'critical' | 'high' | 'medium' | 'low'requirednamestringrequiredexplanationstringrequiredrecommendationOptional[string]referenceOptional[string]sourcestringrequiredidstringrequirednode_idstringrequiredis_borrowedbooleanrequiredlocation_idOptional[string]created_by_userUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_slugstringrequiredcode_idstringrequiredoperationOptional['add' | 'update' | 'delete']actionsFindingActionsrequiredshow properties (3)hide properties (3)
can_editbooleanrequiredcan_revertbooleanrequiredcan_deletebooleanrequiredrevert
POST /security/findings/{finding_id}/revert
result = await client.findings.revert(
finding_id=finding_id,
)Arguments:
finding_idIDpathrequiredReturns: ExistsResponse[FindingSchema]
show properties (2)hide properties (2)
existsbooleanrequireddataOptional[FindingSchema]show properties (21)hide properties (21)
versionAnalysisVersionRefrequiredshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredcreated_atstringrequiredorigin_finding_idstringrequiredis_acknowledgedbooleanrequiredtypestringrequiredlevel'critical' | 'high' | 'medium' | 'low'requirednamestringrequiredexplanationstringrequiredrecommendationOptional[string]referenceOptional[string]sourcestringrequiredidstringrequirednode_idstringrequiredis_borrowedbooleanrequiredlocation_idOptional[string]created_by_userUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_slugstringrequiredcode_idstringrequiredoperationOptional['add' | 'update' | 'delete']actionsFindingActionsrequiredshow properties (3)hide properties (3)
can_editbooleanrequiredcan_revertbooleanrequiredcan_deletebooleanrequiredtoggle_acknowledgement
PATCH /security/findings/{finding_id}/status
result = await client.findings.toggle_acknowledgement(
finding_id=finding_id,
)Arguments:
finding_idIDpathrequiredReturns: FindingSchema
show properties (21)hide properties (21)
versionAnalysisVersionRefrequiredshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredcreated_atstringrequiredorigin_finding_idstringrequiredis_acknowledgedbooleanrequiredtypestringrequiredlevel'critical' | 'high' | 'medium' | 'low'requirednamestringrequiredexplanationstringrequiredrecommendationOptional[string]referenceOptional[string]sourcestringrequiredidstringrequirednode_idstringrequiredis_borrowedbooleanrequiredlocation_idOptional[string]created_by_userUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_slugstringrequiredcode_idstringrequiredoperationOptional['add' | 'update' | 'delete']actionsFindingActionsrequiredshow properties (3)hide properties (3)
can_editbooleanrequiredcan_revertbooleanrequiredcan_deletebooleanrequiredcomments
GET /security/findings/{finding_id}/comments
result = await client.findings.comments(
finding_id=finding_id,
)Arguments:
finding_idIDpathrequiredReturns: ResultsResponse[FindingCommentSchema]
show properties (1)hide properties (1)
resultsarray of FindingCommentSchemashow properties (5)hide properties (5)
idstringrequiredcreated_atstringrequiredmessagestringrequiredrefsarray of InlineRefshow properties (6)hide properties (6)
idstringrequiredtypestringrequiredsourcestringrequiredref_indintegernameOptional[string]is_stalebooleanuserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredcomment
POST /security/findings/{finding_id}/comments
result = await client.findings.comment(
finding_id=finding_id,
message=message,
)Arguments:
finding_idIDpathrequiredmessagestrbodyrequiredReturns: FindingCommentSchema
show properties (5)hide properties (5)
idstringrequiredcreated_atstringrequiredmessagestringrequiredrefsarray of InlineRefshow properties (6)hide properties (6)
idstringrequiredtypestringrequiredsourcestringrequiredref_indintegernameOptional[string]is_stalebooleanuserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequired