Skip to main content

​
Control Block Reference

Detailed reference for all Control Block types and their options.

​
Data Control

​
redact

Remove sensitive data entirely.
OptionTypeRequiredDescription
typestringYesMust be redact
fieldsarrayYesField paths to redact
Behavior:
  • Strings → ""
  • Numbers → 0
  • Booleans → false
  • Objects → {}
  • Arrays → []
- type: redact
  fields:
    - ssn
    - credit_card
    - user.password

​
tokenize

Replace with deterministic tokens.
OptionTypeRequiredDescription
typestringYesMust be tokenize
fieldsarrayYesField paths to tokenize
Behavior:
  • Same input → same token (within one Virtual API)
  • Different Virtual APIs → different tokens
  • Token format: tok_[hash]
- type: tokenize
  fields:
    - email
    - phone
    - customer_id

​
anonymize

Replace with random values preserving structure.
OptionTypeRequiredDescription
typestringYesMust be anonymize
fieldsarrayYesField paths to anonymize
Behavior:
  • Each request produces different values
  • Format is preserved (email looks like email)
  • Not reversible, not correlatable
- type: anonymize
  fields:
    - email
    - name
    - address

​
Data Transform

​
combine

Merge fields into a new field.
OptionTypeRequiredDescription
typestringYesMust be combine
fieldsarrayYesFields to combine (order matters)
intostringYesName of new field
separatorstringNoSeparator between values. Default: " "
remove_sourcebooleanNoRemove original fields. Default: false
- type: combine
  fields:
    - first_name
    - last_name
  into: full_name
  separator: " "
  remove_source: true

​
coalesce

Select first non-empty value.
OptionTypeRequiredDescription
typestringYesMust be coalesce
fieldsarrayYesFields to check (order = priority)
intostringYesName of new field
- type: coalesce
  fields:
    - mobile_phone
    - work_phone
    - home_phone
  into: primary_phone

​
Access Control

Access controls are defined in the access block, not as Control Blocks.

​
expires

OptionTypeDescription
expiresstringISO 8601 date (2025-12-31) or relative (90d)
access:
  expires: 2025-12-31

​
geo_allow / geo_deny

OptionTypeDescription
geo_allowarrayISO 3166-1 alpha-2 country codes to allow
geo_denyarrayISO 3166-1 alpha-2 country codes to deny
access:
  geo_allow:
    - US
    - CA
    - EU  # Special value: all EU countries

​
ip_allow

OptionTypeDescription
ip_allowarrayCIDR ranges to allow
access:
  ip_allow:
    - 10.0.0.0/8
    - 192.168.1.0/24

​
rate_limit

OptionTypeDescription
rate_limit.requestsnumberMax requests per period
rate_limit.periodstringTime period (1m, 1h, 1d)
access:
  rate_limit:
    requests: 10000
    period: 1d

​
Field path syntax

​
Simple fields

fields:
  - email
  - phone

​
Nested fields

fields:
  - user.email
  - billing.address.street

​
Array items

fields:
  - contacts[].email        # All items in array
  - orders[].items[].sku    # Nested arrays

​
Wildcards

fields:
  - "*.email"               # email field at any path
  - "user.*.phone"          # phone in any user sub-object