Gateway module
The Gateway module in Vertex
The gateway is the entry point for all external REST requests to Vertex.
Request tracing and caller attribution
Trace context
Send a W3C traceparent header to link the handling of a request in Vertex to a trace in
your own tooling. B3 and Jaeger trace headers are also accepted; when several are present,
traceparent takes precedence. A missing or malformed trace header never causes a request
to be rejected; Vertex then starts a new trace for that request.
Caller headers
Identify your application and job with the following optional headers. They allow traffic and issues to be traced back to a specific caller and run, without requiring any tracing tooling on your side.
| Header | Purpose | Example |
|---|---|---|
X-EE-Application |
Name of the calling application | PyVertexImporter |
X-EE-Job |
Short logical name of the job or script | daily-import |
X-EE-Run-Id |
Identifier shared by all calls made in one run | 8f14e45f-ceea-467f-a8f5-3c3b6c0e5a01 |
- Use stable application and job names, and generate a new run identifier for every execution.
- These headers are diagnostic labels only: they do not authenticate the caller, grant permissions, or change rate limits.
- Never put credentials, tokens, personal data, or request content in these headers.
Header value rules
- Allowed characters are ASCII letters, digits, spaces,
.,_, and-; other characters are removed. - Values are trimmed and truncated to 128 characters.
- Empty values, repeated headers, comma-separated lists, and values longer than 1,024 characters are ignored.
- An invalid caller header never causes the request itself to be rejected.