v1

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

Guardrails

Describe Policy

Describe the already created Polices

get/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

Response

Success

policy_idstring required

The unique identifier created for each policy.

policy_namestring required

The name of the policy without space or special character

descriptionstring required

A brief explanation of the policy.

statusstring required

Indicates whether the policy is active or inactive.

categorystring required

The category will be either service or resource.

engine_typestring required

Engine type of policy

servicesstring[] required

Displays the service associated with the policy for example, AWS, AzureRM, Openstack., etc

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_typestring required

Content type of policy (Git or File)

contentstring required

The policy content.

git_content_urlstring required

Git project URL when the content type is git.

git_content_usernamestring required

Username of Git repo if repo is authenticated

git_content_pathstring required

Root path of the policy in git repo.

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 of policy

Severity of policy

is_system_policystring required

Flag to identify system policy

uristring required

Unique URI for policy

Example response

{
  "scope": "private",
  "severity": "critical"
}