Versions
Python SDK reference for the analyses.versions resource
Note
The Bevor SDK is coming soon. This page previews its planned Python interface.
Access this resource from client.analyses.versions. Both async and sync clients expose the same methods.
create_chat
POST /chats
result = await client.analyses.versions.create_chat(
version_id=version_id,
)Arguments:
version_idIDbodyrequiredReturns: ChatSchema
show properties (11)hide properties (11)
idstringrequiredcreated_atstringrequiredteam_idstringrequiredteam_slugstringrequiredproject_idstringrequiredproject_slugstringrequiredtotal_messagesintegerrequiredcode_idstringrequiredversion_idOptional[string]titleOptional[string]chat_type'code' | 'analysis'requiredget
GET /security/versions/{version_id}
result = await client.analyses.versions.get(
version_id=version_id,
)Arguments:
version_idIDpathrequiredReturns: VersionSchema
show properties (17)hide properties (17)
idstringrequiredcreated_atstringrequiredtrigger'create' | 'commit' | 'fork' | 'merge' | 'push'requiredn_findingsintegerrequiredn_remediationsintegerrequiredis_headbooleanrequiredhas_pipeline_processingbooleanrequiredhas_pipeline_failedbooleanrequiredcode_versionCodeVersionSchemarequiredshow properties (9)hide properties (9)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredmerged_from_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredforked_from_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredparent_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredchild_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredmerged_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredforked_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredactionsAnalysisActionsrequiredshow properties (10)hide properties (10)
can_forkbooleanrequiredcan_create_childbooleanrequiredcan_commit_changesbooleanrequiredcan_deletebooleanrequiredcan_run_pipelinebooleanrequiredcan_retry_pipelinebooleanrequiredcan_merge_tobooleanrequiredcan_merge_frombooleanrequiredcan_stage_changesbooleanrequiredcan_set_as_headbooleanrequiredanalysis_metaAnalysisMetadataSchemarequiredshow properties (8)hide properties (8)
idstringrequirednamestringrequiredcreated_atstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_namestringrequiredproject_slugstringrequiredis_ownerbooleanrequiredlist
GET /security/versions
result = await client.analyses.versions.list()Arguments:
optionsVersionsQueryParams | Nonequerydefault:
NoneVersionsQueryParams
pageOptional[integer]page_sizeOptional[integer]orderOptional['desc' | 'asc']analysis_idOptional[string]project_idOptional[string]project_slugOptional[string]user_idOptional[string]is_ownerOptional[string]forked_from_version_idOptional[string]merged_from_version_idOptional[string]parent_version_idOptional[string]triggerOptional['create' | 'commit' | 'fork' | 'merge' | 'push']code_idOptional[string]with_paginationboolquerydefault:
FalseReturn type by call:
with_pagination=True→PaginatedResource[VersionSchema]with_pagination=False→Pagination[VersionSchema]
show properties (6)hide properties (6)
resultsarray of VersionSchemashow properties (17)hide properties (17)
idstringrequiredcreated_atstringrequiredtrigger'create' | 'commit' | 'fork' | 'merge' | 'push'requiredn_findingsintegerrequiredn_remediationsintegerrequiredis_headbooleanrequiredhas_pipeline_processingbooleanrequiredhas_pipeline_failedbooleanrequiredcode_versionCodeVersionSchemarequiredshow properties (9)hide properties (9)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredmerged_from_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredforked_from_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredparent_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredchild_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredmerged_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredforked_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredactionsAnalysisActionsrequiredshow properties (10)hide properties (10)
can_forkbooleanrequiredcan_create_childbooleanrequiredcan_commit_changesbooleanrequiredcan_deletebooleanrequiredcan_run_pipelinebooleanrequiredcan_retry_pipelinebooleanrequiredcan_merge_tobooleanrequiredcan_merge_frombooleanrequiredcan_stage_changesbooleanrequiredcan_set_as_headbooleanrequiredanalysis_metaAnalysisMetadataSchemarequiredshow properties (8)hide properties (8)
idstringrequirednamestringrequiredcreated_atstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_namestringrequiredproject_slugstringrequiredis_ownerbooleanrequiredpageintegerrequiredpage_sizeintegerrequiredmorebooleanrequiredtotal_observationsintegerrequiredtotal_pagesintegerrequireddelete
DELETE /security/versions/{version_id}
result = await client.analyses.versions.delete(
version_id=version_id,
)Arguments:
version_idIDpathrequiredReturns: AnalysisSchema
show properties (9)hide properties (9)
idstringrequirednamestringrequiredcreated_atstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredproject_idstringrequiredproject_namestringrequiredproject_slugstringrequiredis_ownerbooleanrequiredversionAnalysisVersionSchemarequiredshow properties (16)hide properties (16)
idstringrequiredcreated_atstringrequiredtrigger'create' | 'commit' | 'fork' | 'merge' | 'push'requiredn_findingsintegerrequiredn_remediationsintegerrequiredis_headbooleanrequiredhas_pipeline_processingbooleanrequiredhas_pipeline_failedbooleanrequiredcode_versionCodeVersionSchemarequiredshow properties (9)hide properties (9)
idstringrequirednetworkOptional['eth' | 'bsc' | 'polygon' | 'base' | 'avax' | 'mode' | 'arb' | 'eth_sepolia' | 'bsc_test' | 'polygon_amoy' | 'base_sepolia' | 'avax_fuji' | 'mode_testnet' | 'arb_sepolia']version_method'tag' | 'commit' | 'hash' | 'address'requiredversion_fingerprintstringrequiredstatus'queued' | 'processing' | 'failed' | 'success'requirednameOptional[string]branchOptional[string]commitOptional[GithubCommitSchema]show properties (4)hide properties (4)
shastringrequiredauthorstringrequiredmessagestringrequiredtimestampstringrequiredrepositoryOptional[GithubRepositorySchema]show properties (4)hide properties (4)
idintegerrequirednamestringrequiredis_privatebooleanrequiredaccountGithubAccountSchemarequiredshow properties (4)hide properties (4)
idintegerrequiredloginstringrequiredtypestringrequiredavatar_urlstringrequiredmerged_from_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredforked_from_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredparent_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredchild_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredmerged_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredforked_versionsarray of AnalysisVersionRefshow properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredactionsAnalysisActionsrequiredshow properties (10)hide properties (10)
can_forkbooleanrequiredcan_create_childbooleanrequiredcan_commit_changesbooleanrequiredcan_deletebooleanrequiredcan_run_pipelinebooleanrequiredcan_retry_pipelinebooleanrequiredcan_merge_tobooleanrequiredcan_merge_frombooleanrequiredcan_stage_changesbooleanrequiredcan_set_as_headbooleanrequired