Skip to Content
Onshore is in early access. Don’t load real customer data until the items in Known limits are closed.
DevelopersHTTP proxy formats

HTTP proxy formats

Create a route in the console first (Web APIs). Call https://<host>/proxy/<route-id>/<path> with X-RV-Route-Key. Whatever the proxy can’t read in full, it doesn’t forward.

BodyHow it’s handled
JSONField rules and detection
Forms (application/x-www-form-urlencoded)Rules name fields: $.bvn, $.customer.bvn for customer[bvn], $.items[*].id for items[0][id]. Every value of a repeated field is replaced
XML and SOAPValues edited where they stand: namespaces, prefixes, order and whitespace arrive as sent. Rules use local names: $.Envelope.Body.Check.BVN, $.Check.@id for an attribute. Detection also reads attributes and comments
MultipartEach field and text file is read; file names are checked. Binary parts follow the file policy
Plain text, CSVDetection only. A route with field rules refuses it
PDF, images, binaryThe file policy

What the bytes are decides, not the label.

File policy

PolicyEffect
refuse (default)A binary body or part is refused with 415
redactPDFs and images go through the file redactor and come back flattened. Anything else, and files the OCR can’t read with confidence, are refused. Needs the files profile
passSent unread and counted as uninspected. An admin must choose this

Headers and query strings

{ "redact_headers": [{ "header": "X-Customer-BVN", "field": "bvn" }], "unredact_headers": [{ "header": "X-Account-Token" }], "response_redact_headers": [{ "header": "X-Result-BVN" }], "dlp_excluded_headers": ["X-Trace-Note"], "dlp_excluded_params": ["reference"] }

Detection reads request headers and every query parameter, skipping credentials and plumbing such as Authorization, Content-Type and Accept unless a rule names them. Rules can’t name framing headers (Host, Content-Length) or Onshore’s own X-RV- headers.

What’s refused with 415, and why

RefusedBecause
A DOCTYPE in XMLIt can define entities the upstream would expand and the proxy can’t see
Malformed XML, not UTF-8, or deeper than 256 levelsIt can’t be read in full
Compressed bodiesThey can’t be read
A charset other than UTF-8, ASCII, Latin-1 or Windows-1252, or a NUL byteA value could pass unseen
Base64 or quoted-printable multipart parts, nested multipartThey carry a value past the checks
A field rule naming a binary partA rule that can’t be honoured mustn’t be ignored
Over 200 parts or 10,000 form fieldsLimits on work per request

Things to check on your upstream

  • Forms and multipart are rewritten in one canonical form. An upstream that checks a signature over the raw body will fail.
  • Multipart keeps only the fields: preamble, epilogue and part headers other than Content-Disposition and Content-Type are dropped.

Values in the URL path aren’t checked (/customers/22333444558 passes), because rewriting a path breaks the request. Detection doesn’t run on responses: responses get only the rules you name.

Last updated on