Policy ManagementCreate Policy

Create Policy

Create a new named policy in the namespace with default entity metadata.

{
  "data": {
    "policy_name": "customer-support-policy"
  }
}
{
  "data": {
    "message": "customer-support-policy created successfully."
  },
  "success": true,
  "error": { "message": "" }
}

Creates a new policy in the namespace with default metadata. After creation, update the policy to configure entity categories and masking behavior.

Endpoint

MethodEndpoint
PUThttps://<domain>/api/vault/metadata/policy/create

Authentication

header
Authorizationstring
Required

Namespace admin bearer token. Format: Bearer <NAMESPACE_ADMIN_API_KEY>

Request body

body
policy_namestring
Required

Unique policy name within the namespace.

Notes

  • Policy names must be unique within the namespace

  • If the policy already exists, the API returns an error — use Update Entity Categories to modify existing policies

  • All supported entities default to pseudonymizable upon creation

  • Use policy_name in Mask and Unmask API calls to apply this policy