You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com. For cross-site search, click Search all in the search results.

Create Data Masks for an API Proxy

Resource Summary

Security

Content Type

application/json, text/xml

Category

Data Mask,

addAPIMaskPost

POST

Create Data Masks for an API Proxy

Create a data mask for an API proxy.

You can capture message content to assist in runtime debugging of APIs calls. In many cases, API traffic contains sensitive data, such credit cards or personally identifiable health information (PHI) that needs to filtered out of the captured message content.

Data masks enable you to specify data that will be filtered out of trace sessions. Data masking is only enabled when a trace session (also called a 'debug' session) is enabled for an API proxy. If no trace session are enabled on an API proxy, then the data will not be masked.

Mask configurations enable you to identify sensitive data in these sources:

XML payloads: Using XPath, you identify XML elements to be filtered from request or response message payloads.

JSON payloads: Using JSONPath, you identify JSON properties to be filtered from request or response message payloads.

Flow variables: You can specify a list of variables that should be masked in debug output.

The basic structure of a mask configuration is shown by the following XML representation:

Header Parameters

Request Body

A list of XPath expressions that will be evaluated against XML payloads (if any) in the request path. Any XPaths that successfully resolve will result in the value of the XML element being masked.

N/A

No

XPathsResponse

A list of XPath expressions that will be evaluated against XML payloads (if any) in the response path. Any XPaths that successfully resolve will result in the value of the XML element being masked.

N/A

No

JSONPathsRequest

A list of JSONPath expressions that will be evaluated against JSON payloads (if any) in the request path. Any JSONPaths that successfully resolve will result in the value of the JSON property being masked.

JSONPathsResponse

A list of JSONPath expressions that will be evaluated against JSON payloads (if any) in the response path. Any JSONPaths that successfully resolve will result in the value of the JSON property being masked.

N/A

No

XPathsFault

A list of XPath expressions that will be evaluated against XML payloads (if any) in the error flow (which executes if a fault is thrown at any point in the flow). Any XPaths that successfully resolve will result in the value of the XML element being masked.

N/A

No

JSONPathsFault

A list of JSON expressions that will be evaluated against XML payloads (if any) in the error flow (which executes if a fault is thrown at any point in the flow). Any JSONPaths that successfully resolve will result in the value of the XML element being masked.

N/A

No

Variables

A list of variables (either pre-defined or custom) who values will be masked.