These HTTP header parameters are set or read by IO. Following RFC 6648, parameter names intentionally do not use the x- prefix.
Application Parameters#
These header parameters are for use by applications that are running behind IO.
proxy-provider#
This is set in Ingress Mode to provide an ingress backend with a comma-separated list of OAuth providers that have currently signed-in sessions.
proxy-session#
This is set in Ingress Mode to provide an ingress backend with a proxy-session value that the backend can set in Calling Mode requests to make API calls with credentials of signed-in users.
proxy-version#
This is set to the current version of IO.
user-did#
This is set in Ingress Mode to inform an ingress backend of the DID of a currently signed-in ATProto user.
user-handle#
This is set in Ingress Mode to inform an ingress backend of the handle of a currently signed-in ATProto user.
user-name#
This is set in Serving Mode when API keys are used and is the username associated with the API key received in the request.
Internal Parameters#
These header parameters are used by IO and aren’t intended for external use. They are documented here for completeness but might be hidden in the future.
proxy-api#
This is set by IO in Calling Mode and Serving Mode to the identifier of the associated API.
proxy-host#
This is set by IO in Ingress Mode to the hostname of the associated ingress.
proxy-mode#
This is set by IO to indicate the mode that is being handled (currently this can only have one of the values calling, serving, or ingress).
proxy-service#
This is set by IO in Serving Mode to the Service Configuration id (if available) for the API being served.
proxy-upstream#
This is set by IO in Calling Mode to indicate the ATProto PDS to which requests will be routed.