v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB
Guardrails

Update Policy

Update Policy details if required after creation using the api, the update by a user depends on the scope of the policy created check create policy docs for more details on the scope

put/governance/guardrails/{tenant_id}/policies/{policy_id}

Path parameters

tenant_idstring required

Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.

policy_idstring required

Specify the policy id to execute, policy id can be obtained from the list policy api

Request body

namestring required

policy name which is unique and does not allow space or special character

display_namestring

Display name of policy which allow space this is to mostly show on the ui

descriptionstring

A brief explanation of the policy.

typestring[]

Indicates the type of policy

categorystring required

The category will be either service or resource

contentstring required

The policy content

is_system_policyboolean

Flag to identify system policies

engine_type'corestack_policy' | 'aws_organization_policy' | 'azure_policy' | 'aws_config' | 'gcp_organization_policy' | 'gcp_policy' | 'kubernetes_policy' | 'oracle_cloud_guard'

Engine type of the policy

cloudstring[]

Displays the cloud associated with the policy

classificationstring required

Policies are classified based on the basis of the activity they perform, for example provisioning, Account Management, Utilization, etc. This value is displayed in this field

sub_classificationstring required

Sub classification for policy

scope'private' | 'account' | 'tenant' required

The scope of the policy: Account scope - All users under that account will have access to view and execute Only Account admins can update/delete the policies, Tenant Scope - Users with access to the specific tenant will have access to policies who can describe or execute policies. Tenant admins can only update/delete. Private Scope - User who created will only have access

content_type'git' | 'file'

Policy content source

content_password_or_keystring

Password or private key to access of Git repo if repo is authenticated required if the content type is git

content_usernamestring

Username of Git repo if repo is authenticated required if the content type is git

content_urlstring

Git project URL when the content type is git required if the content type is git

content_pathstring

Root path of the policy in git repo required if the content type is git

severity'high' | 'low' | 'medium' required

Severity of policy

Example request

{
  "engine_type": "corestack_policy",
  "cloud": [
    "AWS"
  ],
  "scope": "private",
  "content_type": "git",
  "severity": "high"
}

Response

Updated

boolean required