Update an unpublished guardrail version
PATCH
/v1/guardrails/{guardrailId}/versions/{versionId}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 |
|---|---|---|---|---|
| guardrailId | path | string | Yes | — |
| versionId | path | string | Yes | — |
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| label | string | No | — |
| name | string | No | Human-readable name. |
| description | string | No | Human-readable description. |
| snapshot | object | No | — |
| snapshot.schemaVersion | computer_agents_guardrail_v1 | computer_agents_guardrail_v2 | No | — |
| snapshot.name | string | No | Human-readable name. |
| snapshot.description | string | No | Human-readable description. |
| snapshot.prompts | object[] | No | — |
| snapshot.prompts[].id | string | No | Unique identifier. |
| snapshot.prompts[].title | string | Yes | Display title. |
| snapshot.prompts[].prompt | string | Yes | — |
| snapshot.prompts[].createdAt | string | No | ISO 8601 timestamp. |
| snapshot.prompts[].created_at | string | No | — |
| snapshot.prompts[].updatedAt | string | No | ISO 8601 timestamp. |
| snapshot.prompts[].updated_at | string | No | — |
| snapshot.prompts[].metadata | object | No | Free-form metadata object. |
| snapshot.policy | object | No | — |
| snapshot.policy.schemaVersion | computer_agents_guardrail_policy_v1 | Yes | — |
| snapshot.policy.rules | object[] | Yes | — |
| snapshot.policy.rules[].id | string | Yes | Unique identifier. |
| snapshot.policy.rules[].match | object | Yes | — |
| snapshot.policy.rules[].match.actionClasses | string[] | No | — |
| snapshot.policy.rules[].match.operations | string[] | No | — |
| snapshot.policy.rules[].match.targetKinds | string[] | No | — |
| snapshot.policy.rules[].match.dataClassifications | public | internal | confidential | restricted | secret[] | No | — |
| snapshot.policy.rules[].outcome | ask | deny | Yes | Guardrails are restriction-only and cannot grant access. |
| snapshot.policy.rules[].minimumRing | 1 | 2 | 3 | No | — |
| snapshot.policy.rules[].severity | info | warning | high | critical | Yes | — |
| snapshot.policy.rules[].recommendedControl | deny_effect | park | pause | cancel | quarantine | Yes | — |
| snapshot.policy.rules[].obligations | human_approval | security_review | redact_output | verify_target | require_reversible_plan[] | Yes | — |
| snapshot.metadata | object | No | Functional metadata only. Access-control fields are excluded from immutable versions. |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
200Updated versionapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| version | object | Yes | — |
| 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 | archived | Yes | Current lifecycle status. |
| version.snapshot | object | Yes | — |
| version.snapshot.schemaVersion | computer_agents_guardrail_v2 | Yes | — |
| version.snapshot.name | string | Yes | Human-readable name. |
| version.snapshot.description | string | Yes | Human-readable description. |
| version.snapshot.prompts | object[] | Yes | — |
| version.snapshot.prompts[].id | string | No | Unique identifier. |
| version.snapshot.prompts[].title | string | Yes | Display title. |
| version.snapshot.prompts[].prompt | string | Yes | — |
| version.snapshot.prompts[].createdAt | string | No | ISO 8601 timestamp. |
| version.snapshot.prompts[].created_at | string | No | — |
| version.snapshot.prompts[].updatedAt | string | No | ISO 8601 timestamp. |
| version.snapshot.prompts[].updated_at | string | No | — |
| version.snapshot.prompts[].metadata | object | No | Free-form metadata object. |
| version.snapshot.policy | object | Yes | — |
| version.snapshot.policy.schemaVersion | computer_agents_guardrail_policy_v1 | Yes | — |
| version.snapshot.policy.rules | object[] | Yes | — |
| version.snapshot.policy.rules[].id | string | Yes | Unique identifier. |
| version.snapshot.policy.rules[].match | object | Yes | — |
| version.snapshot.policy.rules[].match.actionClasses | string[] | No | — |
| version.snapshot.policy.rules[].match.operations | string[] | No | — |
| version.snapshot.policy.rules[].match.targetKinds | string[] | No | — |
| version.snapshot.policy.rules[].match.dataClassifications | public | internal | confidential | restricted | secret[] | No | — |
| version.snapshot.policy.rules[].outcome | ask | deny | Yes | Guardrails are restriction-only and cannot grant access. |
| version.snapshot.policy.rules[].minimumRing | 1 | 2 | 3 | No | — |
| version.snapshot.policy.rules[].severity | info | warning | high | critical | Yes | — |
| version.snapshot.policy.rules[].recommendedControl | deny_effect | park | pause | cancel | quarantine | Yes | — |
| version.snapshot.policy.rules[].obligations | human_approval | security_review | redact_output | verify_target | require_reversible_plan[] | Yes | — |
| version.snapshot.metadata | object | Yes | Free-form metadata object. |
| version.guardrailFingerprint | string | No | — |
| version.metadata | object | No | Free-form metadata object. |
| version.publishedAt | string | No | — |
| version.createdAt | string | No | ISO 8601 timestamp. |
| version.updatedAt | string | No | ISO 8601 timestamp. |
Update an unpublished guardrail version
Loading...
Response 200
Loading...