Analyses - Bevor Documentation

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

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

`create_root`

POST /security/analyses

result = await client.analyses.create_root(
    code_version_id=code_version_id,
)

result = client.analyses.create_root(
    code_version_id=code_version_id,
)

Parameter	Type	Required	Default
`code_version_id`	`ID`	Yes	`—`
`name`	`str \| None`	No	`None`
`check_existing`	`bool \| None`	No	`None`

Returns: AnalysisCreateSchema

`list`

GET /security/analyses

result = await client.analyses.list()

result = client.analyses.list()

Parameter	Type	Required	Default
`page`	`int \| None`	No	`None`
`page_size`	`int \| None`	No	`None`
`analysis_id`	`ID \| None`	No	`None`
`project_id`	`ID \| None`	No	`None`
`project_slug`	`str \| None`	No	`None`
`user_id`	`ID \| None`	No	`None`
`is_owner`	`bool \| None`	No	`None`
`order_by`	`Literal['created_at', 'updated_at'] \| None`	No	`None`
`order`	`Literal['desc', 'asc'] \| None`	No	`None`

Returns: PaginatedResource[AnalysisSchema]

`get`

GET /security/analyses/{analysis_id}

result = await client.analyses.get(
    analysis_id=analysis_id,
)

result = client.analyses.get(
    analysis_id=analysis_id,
)

Parameter	Type	Required	Default
`analysis_id`	`ID`	Yes	`—`
`env`	`str \| None`	No	`None`

Returns: AnalysisSchema

`recent`

GET /security/analyses/recent

result = await client.analyses.recent()

result = client.analyses.recent()

Parameter	Type	Required	Default
`project_id`	`ID \| None`	No	`None`
`is_github_connection`	`bool \| None`	No	`None`

Returns: ExistsResponse[AnalysisExpandedSchema]

`update`

PATCH /security/analyses/{analysis_id}

result = await client.analyses.update(
    analysis_id=analysis_id,
    name=name,
)

result = client.analyses.update(
    analysis_id=analysis_id,
    name=name,
)

Parameter	Type	Required	Default
`analysis_id`	`ID`	Yes	`—`
`name`	`str`	Yes	`—`

Returns: BooleanResponse

`delete_container`

DELETE /security/analyses/{analysis_id}

result = await client.analyses.delete_container(
    analysis_id=analysis_id,
)

result = client.analyses.delete_container(
    analysis_id=analysis_id,
)

Parameter	Type	Required	Default
`analysis_id`	`ID`	Yes	`—`

Returns: BooleanResponse

`list_refs`

GET /security/analyses/{analysis_id}/refs

result = await client.analyses.list_refs(
    analysis_id=analysis_id,
)

result = client.analyses.list_refs(
    analysis_id=analysis_id,
)

Parameter	Type	Required	Default
`analysis_id`	`ID`	Yes	`—`

Returns: ResultsResponse[AnalysisRefSchema]

`delete_ref`

DELETE /security/analyses/{analysis_id}/refs/{env}

result = await client.analyses.delete_ref(
    analysis_id=analysis_id,
    env=env,
)

result = client.analyses.delete_ref(
    analysis_id=analysis_id,
    env=env,
)

Parameter	Type	Required	Default
`analysis_id`	`ID`	Yes	`—`
`env`	`str`	Yes	`—`

Returns: ResultsResponse[AnalysisRefSchema]

​create_root

​list

​get

​recent

​update

​delete_container

​list_refs

​delete_ref

`create_root`

`list`

`get`

`recent`

`update`

`delete_container`

`list_refs`

`delete_ref`