Authentication Header

string

required

Your unique API key. All v3 API keys are prefixed with qapi_.

You can manage and rotate your API keys in the API Keys section.

Content Control

string

required

Must be set to application/json for all requests containing a JSON payload.

string

A comma-separated list of fields in the JSON payload to be processed (encrypted or decrypted).

This header is required for encryption and decryption requests. For other API calls, it can be omitted.

Dot Notation: You can use dot notation to target nested fields within multi-dimensional objects.

Dot Notation Example

When working with nested JSON structures, use the X-Qanapi-Fields header to specify exactly which fields should be touched.

Request

curl -X POST https://{subdomain}.qanapi.cloud/api/v3/encryption/{proxy}/encrypt \
  -H "X-Qanapi-Authorization: qapi_..." \
  -H "X-Qanapi-Fields: user.email, user.address.zip" \
  -d '{
    "user": {
      "name": "John Doe",
      "email": "john@example.com",
      "address": {
        "city": "New York",
        "zip": "10001"
      }
    }
  }'

Advanced Routing

string

A URL to forward the request to after processing. If provided, Qanapi will act as a transparent proxy.

When using X-Qanapi-Destination, all non-Qanapi headers (e.g., Authorization, Custom-App-Header) will be forwarded to the destination URL along with the processed payload.

Try it out

See these headers in action by testing the Encryption endpoints.

Overview

Encrypt data

Details

Encryption

Roles

Users

Configurations

API Keys

Logs

Custom Headers

Authentication Header

Content Control

Dot Notation Example

Advanced Routing

Try it out

​Authentication Header

​Content Control

​Dot Notation Example

​Advanced Routing

Try it out

Authentication Header

Content Control

Dot Notation Example

Advanced Routing