Publish a guardrail version

POST/v1/guardrails/{guardrailId}/versions/{versionId}/publish

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
NameLocationTypeRequiredDescription
guardrailIdpathstringYes
versionIdpathstringYes
Query parameters
None.

Body schema

Content type: application/json · Optional

FieldTypeRequiredDescription
snapshotobjectNo
snapshot.schemaVersioncomputer_agents_guardrail_v1 | computer_agents_guardrail_v2No
snapshot.namestringNoHuman-readable name.
snapshot.descriptionstringNoHuman-readable description.
snapshot.promptsobject[]No
snapshot.prompts[].idstringNoUnique identifier.
snapshot.prompts[].titlestringYesDisplay title.
snapshot.prompts[].promptstringYes
snapshot.prompts[].createdAtstringNoISO 8601 timestamp.
snapshot.prompts[].created_atstringNo
snapshot.prompts[].updatedAtstringNoISO 8601 timestamp.
snapshot.prompts[].updated_atstringNo
snapshot.prompts[].metadataobjectNoFree-form metadata object.
snapshot.policyobjectNo
snapshot.policy.schemaVersioncomputer_agents_guardrail_policy_v1Yes
snapshot.policy.rulesobject[]Yes
snapshot.policy.rules[].idstringYesUnique identifier.
snapshot.policy.rules[].matchobjectYes
snapshot.policy.rules[].match.actionClassesstring[]No
snapshot.policy.rules[].match.operationsstring[]No
snapshot.policy.rules[].match.targetKindsstring[]No
snapshot.policy.rules[].match.dataClassificationspublic | internal | confidential | restricted | secret[]No
snapshot.policy.rules[].outcomeask | denyYesGuardrails are restriction-only and cannot grant access.
snapshot.policy.rules[].minimumRing1 | 2 | 3No
snapshot.policy.rules[].severityinfo | warning | high | criticalYes
snapshot.policy.rules[].recommendedControldeny_effect | park | pause | cancel | quarantineYes
snapshot.policy.rules[].obligationshuman_approval | security_review | redact_output | verify_target | require_reversible_plan[]Yes
snapshot.metadataobjectNoFunctional metadata only. Access-control fields are excluded from immutable versions.

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Published guardrailapplication/json
FieldTypeRequiredDescription
guardrailobjectYes
guardrail.idstringYesUnique identifier.
guardrail.namestringYesHuman-readable name.
guardrail.descriptionstringYesHuman-readable description.
guardrail.promptsobject[]Yes
guardrail.prompts[].idstringNoUnique identifier.
guardrail.prompts[].titlestringYesDisplay title.
guardrail.prompts[].promptstringYes
guardrail.prompts[].createdAtstringNoISO 8601 timestamp.
guardrail.prompts[].created_atstringNo
guardrail.prompts[].updatedAtstringNoISO 8601 timestamp.
guardrail.prompts[].updated_atstringNo
guardrail.prompts[].metadataobjectNoFree-form metadata object.
guardrail.policyobjectYes
guardrail.policy.schemaVersioncomputer_agents_guardrail_policy_v1Yes
guardrail.policy.rulesobject[]Yes
guardrail.policy.rules[].idstringYesUnique identifier.
guardrail.policy.rules[].matchobjectYes
guardrail.policy.rules[].match.actionClassesstring[]No
guardrail.policy.rules[].match.operationsstring[]No
guardrail.policy.rules[].match.targetKindsstring[]No
guardrail.policy.rules[].match.dataClassificationspublic | internal | confidential | restricted | secret[]No
guardrail.policy.rules[].outcomeask | denyYesGuardrails are restriction-only and cannot grant access.
guardrail.policy.rules[].minimumRing1 | 2 | 3No
guardrail.policy.rules[].severityinfo | warning | high | criticalYes
guardrail.policy.rules[].recommendedControldeny_effect | park | pause | cancel | quarantineYes
guardrail.policy.rules[].obligationshuman_approval | security_review | redact_output | verify_target | require_reversible_plan[]Yes
guardrail.sourcecustom | defaultYes
guardrail.isDefaultbooleanYes
guardrail.readOnlybooleanYes
guardrail.publishedVersionIdstringNo
guardrail.metadataobjectNoFree-form metadata object.
guardrail.createdAtstringNoISO 8601 timestamp.
guardrail.updatedAtstringNoISO 8601 timestamp.
Publish a guardrail version
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow