Remove

Removes headers, parameters, or fields from messages.

Use the Remove policy to delete specific headers, query parameters, or message fields before the request is forwarded or returned.

For more information on the policy parameter descriptions, see DataPower Nano Gateway documentation.

Example of a Remove policy in code view.

--- #remove message
kind: remove #same for remove
apiVersion: api.ibm.com/v1
metadata:
  name: "remove-request"
  version: 1.0
  namespace: sample
spec:
  message:
    messageName: "request"
    queryParameters:
      - token
      - trace
    headers:
      - X-API-Key
      - X-Auth-Token
    body:
      captures: #OneOf
        jsonata: #allows either regex or jsonata, but not both
          - "doc.key.password"
          - "doc.key.user"
--- #remove variable/distributedVariable
kind: remove #same for remove
apiVersion: api.ibm.com/v1
metadata:
  name: "remove-variable"
  version: 1.0
  namespace: sample
spec:
  variable: #same for distributedVariable
    name: "my-custom-var-1"
    captures:
      jsonata:
        - "doc.key.password"
        - "doc.key.user"
--- #remove variable/distributedVariable
kind: remove #same for remove
apiVersion: api.ibm.com/v1
metadata:
  name: "remove-distributed-variable"
  version: 1.0
  namespace: sample
spec:
  distributedVariable: #same for distributedVariable
    name: "my-custom-var-1"
    captures:
      jsonata:
        - "doc.key.password"
        - "doc.key.user"
---
kind: remove
apiVersion: api.ibm.com/v1
metadata:
  name: "remove-telemetry"
  version: 1.0
  namespace: sample
spec:
  telemetry:
    keys:
      - "key1"
    span: "rootSpan"
    # # (2/3) policySpan
    # span:
    #   policySpan: ""
    # # (3/3) httpSpan
    # span:
    #  httpSpan: ""