EnterpriseCodeScansClient

Constructor

EnterpriseCodeScansClient(options: BaseClientOptions): CodeScansClient

Parameters

BaseClientOptions

required

Returns

CodeScansClient

Methods

getCodeScanMetrics()

getCodeScanMetrics(request: GetCodeScanMetricsCodeScansRequest, requestOptions?: RequestOptions): HttpResponsePromise<CodeScanMetricsResponse>

Get aggregated code scan metrics for the enterprise account. Returns scan, finding, and remediation-PR metrics for code scans created within the specified time range, optionally filtered to specific organizations.

await client.enterprise.codeScans.getCodeScanMetrics({
        time_before: 1,
        time_after: 1
    })

Parameters

GetCodeScanMetricsCodeScansRequest

required

RequestOptions

Request-specific configuration.

Returns

CodeScanMetricsResponse

getCodeScanProfile()

getCodeScanProfile(request: GetCodeScanProfileCodeScansRequest, requestOptions?: RequestOptions): HttpResponsePromise<CodeScanProfileDetailResponse>

Get a code scan profile by ID. Returns the profile’s metadata, visibility (org-owned or shared account-wide), and all of its guidance fields. Returns 404 when the profile does not exist or is not visible to the enterprise account.

await client.enterprise.codeScans.getCodeScanProfile({
        profile_id: "profile_id"
    })

Parameters

GetCodeScanProfileCodeScansRequest

required

RequestOptions

Request-specific configuration.

Returns

CodeScanProfileDetailResponse

listCodeScanFindings()

listCodeScanFindings(request?: ListCodeScanFindingsCodeScansRequest, requestOptions?: RequestOptions): Promise<Page<CodeScanFindingResponse, PaginatedResponseCodeScanFindingResponse>>

List code scan findings for the enterprise account. Findings are returned newest first. Optionally filter by org_ids, scan_id, repo_name, severity, and status (severity and status accept multiple values); results are paginated with an opaque cursor (after / first).

await client.enterprise.codeScans.listCodeScanFindings()

Parameters

ListCodeScanFindingsCodeScansRequest

RequestOptions

Request-specific configuration.

Returns

CodeScanFindingResponsePaginatedResponseCodeScanFindingResponse

listCodeScanProfiles()

listCodeScanProfiles(request?: ListCodeScanProfilesCodeScansRequest, requestOptions?: RequestOptions): Promise<Page<CodeScanProfileSummaryResponse, PaginatedResponseCodeScanProfileSummaryResponse>>

List code scan profiles for the enterprise account. Returns profile summaries (without guidance) newest first, including both org-owned and account-shared profiles. Optionally filter by org_ids; results are paginated with an opaque cursor (after / first).

await client.enterprise.codeScans.listCodeScanProfiles()

Parameters

ListCodeScanProfilesCodeScansRequest

RequestOptions

Request-specific configuration.

Returns

CodeScanProfileSummaryResponsePaginatedResponseCodeScanProfileSummaryResponse

listCodeScans()

listCodeScans(request?: ListCodeScansCodeScansRequest, requestOptions?: RequestOptions): Promise<Page<CodeScanResponse, PaginatedResponseCodeScanResponse>>

List code scans for the enterprise account. Scans are returned newest first. Optionally filter by org_ids, repo_name, and creation time (time_after / time_before); results are paginated with an opaque cursor (after / first).

await client.enterprise.codeScans.listCodeScans()

Parameters

ListCodeScansCodeScansRequest

RequestOptions

Request-specific configuration.

Returns

CodeScanResponsePaginatedResponseCodeScanResponse

remediateCodeScanFinding()

remediateCodeScanFinding(request: RemediateCodeScanFindingCodeScansRequest, requestOptions?: RequestOptions): HttpResponsePromise<RemediateFindingResponse>

Launch a Devin session to remediate a code scan finding. The session analyzes the vulnerable code, implements a fix, and opens a pull request. The session is attributed to the calling principal (the service user or PAT that made the request). Returns 409 if the finding already has a remediation session.

await client.enterprise.codeScans.remediateCodeScanFinding({
        org_id: "org-abc123def456",
        scan_id: "scan_id",
        finding_id: "finding_id"
    })

Parameters

RemediateCodeScanFindingCodeScansRequest

required

RequestOptions

Request-specific configuration.

Returns

RemediateFindingResponse

Get started

Sessions

Integrations

Examples

SDK reference

API client

Resources

EnterpriseCodeScansClient

Constructor

Parameters

Returns

Methods

getCodeScanMetrics()

Parameters

Returns

getCodeScanProfile()

Parameters

Returns

listCodeScanFindings()

Parameters

Returns

listCodeScanProfiles()

Parameters

Returns

listCodeScans()

Parameters

Returns

remediateCodeScanFinding()

Parameters

Returns

​Constructor

​Parameters

​Returns

​Methods

​getCodeScanMetrics()

​Parameters

​Returns

​getCodeScanProfile()

​Parameters

​Returns

​listCodeScanFindings()

​Parameters

​Returns

​listCodeScanProfiles()

​Parameters

​Returns

​listCodeScans()

​Parameters

​Returns

​remediateCodeScanFinding()

​Parameters

​Returns

Constructor

Parameters

Returns

Methods

getCodeScanMetrics()

Parameters

Returns

getCodeScanProfile()

Parameters

Returns

listCodeScanFindings()

Parameters

Returns

listCodeScanProfiles()

Parameters

Returns

listCodeScans()

Parameters

Returns

remediateCodeScanFinding()

Parameters

Returns