PCI Vault Logo
Rules

PCI Vault has a built-in rule engine for transforming incoming or outgoing data on certain endpoints.

Each rule has an ID and a list of operations which will be applied to the data in order they have been specified in.

Each operation has an input field, an output field, and a name. The name specifies which operation gets applied. The specified operation is applied to the data contained in the input field anf written to the output field.

Some operations have required or optional arguments to control their behaviour. These arguments need to specified in the arguments field of the operation when creating a rule.

If the input field does not exist, the operation will be skipped. If the output field already contains data, the operation will overwrite that data.

GET /rule/ Get Rule(s)
PCI DSS Scope: N/A

List available rules. Specify an id to retrieve just the rule specified by the ID.

(query)

A unique id for looking up a specific rule.

GET
https://api.pcivault.io/v1/rule/
# No Body
Response Code: 200 (example) 


POST /rule/
Add rule



PCI DSS Scope:
N/A




Create a new rule.
The operation will be applied in the same order that they have been specified in by this endpoint.





(query)





A unique id for the rule you want to use.








A list of valid operation objects.














POST


https://api.pcivault.io/v1/rule/










Response Code: 200
(example)







DELETE /rule/
Delete Rule



PCI DSS Scope:
N/A




Delete a rule.
There can only be one rule for each id.
If you made a mistake when creating a rule, you can delete it here.





(query)





The unique id for the rule you'd like to delete.








DELETE


https://api.pcivault.io/v1/rule/






# No Body


Response Code: 200
(example)







GET /rule/operations
Get Operations



PCI DSS Scope:
N/A




Retrieve a list of available operations and their names.








GET


https://api.pcivault.io/v1/rule/operations






# No Body


Response Code: 200
(example)