Analyses

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

list

GET /security/analyses

result = await client.analyses.list()

Arguments:

Return type by call:

• with_pagination=True → PaginatedResource[AnalysisSchema]
• with_pagination=False → Pagination[AnalysisSchema]

get

GET /security/analyses/{analysis_id}

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

Arguments:

Returns: AnalysisSchema

recent

GET /security/analyses/recent

result = await client.analyses.recent()

Arguments:

Returns: ExistsResponse[AnalysisExpandedSchema]

update

PATCH /security/analyses/{analysis_id}

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

Arguments:

Returns: AnalysisSchema

delete

DELETE /security/analyses/{analysis_id}

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

Arguments:

Returns: BooleanResponse

create_root

POST /security/analyses

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

Arguments:

Returns: AnalysisCreateSchema

create_child

POST /security/analyses/{analysis_id}/child

result = await client.analyses.create_child(
    analysis_id=analysis_id,
    body=body,
)

Arguments:

Returns: AnalysisCreateSchema

fork

POST /security/analyses/{analysis_id}/fork

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

Arguments:

Returns: AnalysisSchema

merge

POST /security/merge

result = await client.analyses.merge(
    body=body,
)

Arguments:

Returns: AnalysisSchema

commit

POST /security/analyses/{analysis_id}/commit

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

Arguments:

Returns: AnalysisSchema

set_head

POST /security/analyses/{version_id}/head

result = await client.analyses.set_head(
    analysis_id=analysis_id,
    body=body,
)

Arguments:

Returns: AnalysisSchema

entrypoints

GET /security/analyses/{analysis_id}/entrypoints

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

Arguments:

Returns: ResultsResponse[EntryPointSchema]

list_findings

GET /security/analyses/{analysis_id}/findings

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

Arguments:

Returns: ResultsResponse[FindingSchema]

add_findings

POST /security/analyses/{analysis_id}/findings

result = await client.analyses.add_findings(
    analysis_id=analysis_id,
    body=body,
)

Arguments:

Returns: ResultsResponse[FindingSchema]

diff_staged

GET /security/analyses/{analysis_id}/diff/staged

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

Arguments:

Returns: ResultsResponse[FindingDiffItem]

diff_version

GET /security/analyses/{analysis_id}/diff/version

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

Arguments:

Returns: ResultsResponse[FindingDiffItem]

run

POST /security/analyses/{analysis_id}/run

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

Arguments:

Return type by call:

• with_streaming=True → EventResource[AnalysisSchema, AnalysisRunStatusEventData]
• with_streaming=False → AnalysisSchema

retry

POST /security/analyses/{analysis_id}/retry

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

Arguments:

Return type by call:

• with_streaming=True → EventResource[AnalysisSchema, AnalysisRunStatusEventData]
• with_streaming=False → AnalysisSchema

Scoped access

Calling client.analyses(analysis_id) returns a resource scoped to that analysis, exposing the same nested resources listed here (.remediations, .versions, .summary) pre-bound to it.