Get the repository security overview
GET
/v1/security/overviewReturns organization-scoped repository, finding, and run aggregates. Requires security:read.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Header parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| X-Computer-Agents-Organization | header | string | No | Active organization context. If omitted, the authenticated user's personal organization is used. |
Body schema
This endpoint does not require a request body.
None.
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Security overviewapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| metrics | object | Yes | — |
| metrics.repositories | integer | Yes | — |
| metrics.activeRepositories | integer | Yes | — |
| metrics.openFindings | integer | Yes | — |
| metrics.criticalFindings | integer | Yes | — |
| metrics.highFindings | integer | Yes | — |
| metrics.fixedFindings | integer | Yes | — |
| metrics.totalRuns | integer | Yes | — |
| metrics.successfulRuns | integer | Yes | — |
| metrics.failedRuns | integer | Yes | — |
| metrics.activeRuns | integer | Yes | — |
| repositories | object[] | Yes | — |
| repositories[].ownershipInvitation | object | No | — |
| repositories[].ownershipInvitation.id | string | Yes | Unique identifier. |
| repositories[].ownershipInvitation.organizationId | string | Yes | — |
| repositories[].ownershipInvitation.kind | share | ownership | Yes | — |
| repositories[].ownershipInvitation.resourceType | string | Yes | — |
| repositories[].ownershipInvitation.resourceId | string | Yes | — |
| repositories[].ownershipInvitation.resourceName | string | Yes | — |
| repositories[].ownershipInvitation.recipientUserId | string | Yes | — |
| repositories[].ownershipInvitation.invitedByUserId | string | Yes | — |
| repositories[].ownershipInvitation.accessLevel | use | edit | manage | Yes | — |
| repositories[].ownershipInvitation.status | pending | accepted | declined | revoked | expired | Yes | Current lifecycle status. |
| repositories[].ownershipInvitation.expiresAt | string | Yes | — |
| repositories[].ownershipInvitation.decidedAt | string | Yes | — |
| repositories[].ownershipInvitation.createdAt | string | Yes | ISO 8601 timestamp. |
| repositories[].ownershipInvitation.updatedAt | string | Yes | ISO 8601 timestamp. |
| repositories[].id | string | Yes | Unique identifier. |
| repositories[].githubRepositoryId | string | Yes | — |
| repositories[].githubInstallationId | string | Yes | — |
| repositories[].githubNumericRepositoryId | string | No | — |
| repositories[].githubNumericInstallationId | string | No | — |
| repositories[].fullName | string | Yes | — |
| repositories[].defaultBranch | string | Yes | — |
| repositories[].private | boolean | Yes | — |
| repositories[].archived | boolean | Yes | — |
| repositories[].status | active | paused | disconnected | Yes | Current lifecycle status. |
| repositories[].currentPolicyVersionId | string | No | — |
| repositories[].currentThreatModelVersionId | string | No | — |
| repositories[].permissionSet | object | No | — |
| repositories[].lastRunId | string | No | — |
| repositories[].lastRunAt | string | No | — |
| repositories[].nextScanAt | string | No | — |
| repositories[].metadata | object | No | Free-form metadata object. |
| repositories[].findingCounts | object | Yes | — |
| repositories[].findingCounts.open | integer | Yes | — |
| repositories[].findingCounts.critical | integer | Yes | — |
| repositories[].findingCounts.high | integer | Yes | — |
| repositories[].lastRunStatus | queued | running | waiting_approval | succeeded | partial | failed | cancelled | No | — |
| repositories[].lastRunStage | ingest | checkout | inventory | scan | validate | triage | remediate | verify | publish | complete | No | — |
| repositories[].createdAt | string | Yes | ISO 8601 timestamp. |
| repositories[].updatedAt | string | Yes | ISO 8601 timestamp. |
Get the repository security overview
Loading...
Response 200
Loading...