Update a saved repository security configuration version
PATCH
/v1/security/repositories/{repositoryId}/versions/{versionId}Published snapshots remain immutable through this endpoint; publishing explicitly applies an updated snapshot.
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
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| repositoryId | path | string | Yes | Monitored security repository ID |
| versionId | path | string | Yes | — |
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
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| snapshot | object | No | A coherent executable security configuration. Authorization, GitHub identity, monitoring state, findings, and evidence are intentionally not versioned. |
| snapshot.schemaVersion | 1 | Yes | — |
| snapshot.policy | object | Yes | — |
| snapshot.policy.schemaVersion | 1 | Yes | — |
| snapshot.policy.defaultBranch | string | Yes | — |
| snapshot.policy.scanMode | full | incremental | Yes | — |
| snapshot.policy.schedule | object | Yes | — |
| snapshot.policy.schedule.enabled | boolean | Yes | — |
| snapshot.policy.schedule.cron | string | Yes | — |
| snapshot.policy.schedule.timezone | string | Yes | — |
| snapshot.policy.pullRequests | object | Yes | — |
| snapshot.policy.pullRequests.enabled | boolean | Yes | — |
| snapshot.policy.pullRequests.branches | string[] | Yes | — |
| snapshot.policy.pullRequests.pathIncludes | string[] | Yes | — |
| snapshot.policy.pullRequests.pathExcludes | string[] | Yes | — |
| snapshot.policy.pullRequests.scanForksReadOnly | true | Yes | — |
| snapshot.policy.push | object | Yes | — |
| snapshot.policy.push.enabled | boolean | Yes | — |
| snapshot.policy.push.branches | string[] | Yes | — |
| snapshot.policy.scanners | string[] | Yes | — |
| snapshot.policy.remediation | object | Yes | — |
| snapshot.policy.remediation.mode | disabled | approval_required | Yes | — |
| snapshot.policy.remediation.minimumSeverity | critical | high | medium | low | informational | Yes | — |
| snapshot.policy.remediation.draftPullRequestsOnly | true | Yes | — |
| snapshot.policy.remediation.allowWorkflowChanges | false | Yes | — |
| snapshot.policy.remediation.maximumChangedFiles | integer | Yes | — |
| snapshot.policy.remediation.maximumPatchBytes | integer | Yes | — |
| snapshot.threatModel | object | Yes | — |
| snapshot.threatModel.schemaVersion | 1 | Yes | — |
| snapshot.threatModel.summary | string | Yes | — |
| snapshot.threatModel.entryPoints | string[] | Yes | — |
| snapshot.threatModel.untrustedInputs | string[] | Yes | — |
| snapshot.threatModel.trustBoundaries | string[] | Yes | — |
| snapshot.threatModel.sensitiveDataPaths | string[] | Yes | — |
| snapshot.threatModel.privilegedActions | string[] | Yes | — |
| snapshot.threatModel.priorityAreas | string[] | Yes | — |
| snapshot.threatModel.exclusions | object[] | Yes | — |
| snapshot.threatModel.exclusions[].path | string | Yes | Workspace-relative file path. |
| snapshot.threatModel.exclusions[].reason | string | Yes | — |
| description | string | No | Human-readable description. |
| label | string | No | — |
| name | string | No | Human-readable name. |
| metadata | object | No | Free-form metadata object. |
| publish | boolean | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Updated repository security versionapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| version | object | No | — |
| version.id | string | Yes | Unique identifier. |
| version.version | integer | Yes | — |
| version.label | string | Yes | — |
| version.name | string | Yes | Human-readable name. |
| version.description | string | Yes | Human-readable description. |
| version.status | saved | published | Yes | Current lifecycle status. |
| version.snapshot | object | Yes | A coherent executable security configuration. Authorization, GitHub identity, monitoring state, findings, and evidence are intentionally not versioned. |
| version.snapshot.schemaVersion | 1 | Yes | — |
| version.snapshot.policy | object | Yes | — |
| version.snapshot.policy.schemaVersion | 1 | Yes | — |
| version.snapshot.policy.defaultBranch | string | Yes | — |
| version.snapshot.policy.scanMode | full | incremental | Yes | — |
| version.snapshot.policy.schedule | object | Yes | — |
| version.snapshot.policy.schedule.enabled | boolean | Yes | — |
| version.snapshot.policy.schedule.cron | string | Yes | — |
| version.snapshot.policy.schedule.timezone | string | Yes | — |
| version.snapshot.policy.pullRequests | object | Yes | — |
| version.snapshot.policy.pullRequests.enabled | boolean | Yes | — |
| version.snapshot.policy.pullRequests.branches | string[] | Yes | — |
| version.snapshot.policy.pullRequests.pathIncludes | string[] | Yes | — |
| version.snapshot.policy.pullRequests.pathExcludes | string[] | Yes | — |
| version.snapshot.policy.pullRequests.scanForksReadOnly | true | Yes | — |
| version.snapshot.policy.push | object | Yes | — |
| version.snapshot.policy.push.enabled | boolean | Yes | — |
| version.snapshot.policy.push.branches | string[] | Yes | — |
| version.snapshot.policy.scanners | string[] | Yes | — |
| version.snapshot.policy.remediation | object | Yes | — |
| version.snapshot.policy.remediation.mode | disabled | approval_required | Yes | — |
| version.snapshot.policy.remediation.minimumSeverity | critical | high | medium | low | informational | Yes | — |
| version.snapshot.policy.remediation.draftPullRequestsOnly | true | Yes | — |
| version.snapshot.policy.remediation.allowWorkflowChanges | false | Yes | — |
| version.snapshot.policy.remediation.maximumChangedFiles | integer | Yes | — |
| version.snapshot.policy.remediation.maximumPatchBytes | integer | Yes | — |
| version.snapshot.threatModel | object | Yes | — |
| version.snapshot.threatModel.schemaVersion | 1 | Yes | — |
| version.snapshot.threatModel.summary | string | Yes | — |
| version.snapshot.threatModel.entryPoints | string[] | Yes | — |
| version.snapshot.threatModel.untrustedInputs | string[] | Yes | — |
| version.snapshot.threatModel.trustBoundaries | string[] | Yes | — |
| version.snapshot.threatModel.sensitiveDataPaths | string[] | Yes | — |
| version.snapshot.threatModel.privilegedActions | string[] | Yes | — |
| version.snapshot.threatModel.priorityAreas | string[] | Yes | — |
| version.snapshot.threatModel.exclusions | object[] | Yes | — |
| version.snapshot.threatModel.exclusions[].path | string | Yes | Workspace-relative file path. |
| version.snapshot.threatModel.exclusions[].reason | string | Yes | — |
| version.metadata | object | No | Free-form metadata object. |
| version.publishedAt | string | No | — |
| version.createdAt | string | Yes | ISO 8601 timestamp. |
| version.updatedAt | string | Yes | ISO 8601 timestamp. |
404Resource not foundapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| error | string | No | — |
Update a saved repository security configuration version
Loading...
Response 200
Loading...