Remediations

Python SDK reference for the analyses.remediations resource

Note

The Bevor SDK is coming soon. This page previews its planned Python interface.

Access this resource from client.analyses.remediations. Both async and sync clients expose the same methods.

list

GET /security/remediations

result = await client.analyses.remediations.list()

Arguments:

optionsRemediationQueryParams | Nonequery
default:None

RemediationQueryParams

pageOptional[integer]
page_sizeOptional[integer]
order_byOptional['created_at' | 'updated_at']
orderOptional['desc' | 'asc']
project_idOptional[string]
project_slugOptional[string]
parent_version_idOptional[string]
child_version_idOptional[string]
with_paginationboolquery
default:False

Return type by call:

  • with_pagination=True → PaginatedResource[RemediationSchema]
  • with_pagination=False → Pagination[RemediationSchema]
show properties (6)hide properties (6)
resultsarray of RemediationSchema
show properties (6)hide properties (6)
idstringrequired
created_atstringrequired
parentAnalysisVersionRefrequired
show properties (2)hide properties (2)
idstringrequired
analysis_idstringrequired
childAnalysisVersionRefrequired
show properties (2)hide properties (2)
idstringrequired
analysis_idstringrequired
findingFindingSchemarequired
show properties (21)hide properties (21)
versionAnalysisVersionRefrequired
show properties (2)hide properties (2)
idstringrequired
analysis_idstringrequired
created_atstringrequired
origin_finding_idstringrequired
is_acknowledgedbooleanrequired
typestringrequired
level'critical' | 'high' | 'medium' | 'low'required
namestringrequired
explanationstringrequired
recommendationOptional[string]
referenceOptional[string]
sourcestringrequired
idstringrequired
node_idstringrequired
is_borrowedbooleanrequired
location_idOptional[string]
created_by_userUserSchemarequired
show properties (4)hide properties (4)
idstringrequired
is_selfbooleanrequired
created_atstringrequired
usernamestringrequired
project_idstringrequired
project_slugstringrequired
code_idstringrequired
operationOptional['add' | 'update' | 'delete']
actionsFindingActionsrequired
show properties (3)hide properties (3)
can_editbooleanrequired
can_revertbooleanrequired
can_deletebooleanrequired
can_updatebooleanrequired
pageintegerrequired
page_sizeintegerrequired
morebooleanrequired
total_observationsintegerrequired
total_pagesintegerrequired

get

GET /security/remediations/{remediation_id}

result = await client.analyses.remediations.get(
    remediation_id=remediation_id,
)

Arguments:

remediation_idIDpathrequired

Returns: RemediationSchema

show properties (6)hide properties (6)
idstringrequired
created_atstringrequired
parentAnalysisVersionRefrequired
show properties (2)hide properties (2)
idstringrequired
analysis_idstringrequired
childAnalysisVersionRefrequired
show properties (2)hide properties (2)
idstringrequired
analysis_idstringrequired
findingFindingSchemarequired
show properties (21)hide properties (21)
versionAnalysisVersionRefrequired
show properties (2)hide properties (2)
idstringrequired
analysis_idstringrequired
created_atstringrequired
origin_finding_idstringrequired
is_acknowledgedbooleanrequired
typestringrequired
level'critical' | 'high' | 'medium' | 'low'required
namestringrequired
explanationstringrequired
recommendationOptional[string]
referenceOptional[string]
sourcestringrequired
idstringrequired
node_idstringrequired
is_borrowedbooleanrequired
location_idOptional[string]
created_by_userUserSchemarequired
show properties (4)hide properties (4)
idstringrequired
is_selfbooleanrequired
created_atstringrequired
usernamestringrequired
project_idstringrequired
project_slugstringrequired
code_idstringrequired
operationOptional['add' | 'update' | 'delete']
actionsFindingActionsrequired
show properties (3)hide properties (3)
can_editbooleanrequired
can_revertbooleanrequired
can_deletebooleanrequired
can_updatebooleanrequired

On this page