Payload
This page shows once the full possible request payload against the shared library, with all default values.
Basic Request Input
Field | Type | Description |
---|---|---|
headers | Map<string, string> | Headers to attach on the current request. defaultHeaders will be used when empty. |
defaultHeaders | Map<string, Array<string>> | Default Headers to be used when no request headers are specified. The default header order can be specified with the Key "Header-Order:" |
serverNameOverwrite | string | Lookup Client Option "WithServerNameOverwrite" |
sessionId
is optional. When not provided the API does not create a Session. On every forwarded request with a given sessionId you will receive the sessionId in the response to be able to reuse sessions (cookies).Be aware that
insecureSkipVerify
and thetimeoutSeconds
can not be changed during a session.followRedirects
andproxyUrl
can be changed within a session.If you do not want to set
requestBody
orproxyUrl
usenull
instead of empty stringWhen you set
isByteResponse
totrue
the response body will be a base64 encoded string. Useful when you want to download images for example.When you set
isByteRequest
totrue
the request body needs to be a base64 encoded string. Useful when you want to upload images for example.
Custom TLS-Client
Field | Type | Descirption |
---|---|---|
certCompressionAlgo | string | See possible values at the end of this page |
connectionFlow | integer | |
h2Settings | Map<string, int> | See possible values for the Map keys at the end of this page. |
h2SettingsOrder | Array<string> | Array of string keys which are used in the h2Settings property but ordered. |
headerPriority | PriorityParam | See type definition below in next section |
ja3String | string | |
keyShareCurves | Array<string> | See possible values at the end of this page |
priorityFrames | Array<PriorityFrames> | See type definition below in next section |
alpnProtocols | Array<string> | List of supported protocols for the ALPN Extension |
alpsProtocols | Array<string> | List of supported protocols for the ALPS Extension |
ECHCandidatePayloads | Array<uint16> | List of ECH Candidate Payloads |
ECHCandidateCipherSuites | Array<CanidateCipherSuite> | See type definition below in next section |
pseudoHeaderOrder | Array<string> | See possible values at the end of this page |
supportedDelegatedCredentialsAlgorithms | Array<string> | See possible values at the end of this page |
supportedSignatureAlgorithms | Array<string> | See possible values at the end of this page |
supportedVersions | Array<string> | See possible values at the end of this page |
TransportOptions
Field | Type | Description |
---|---|---|
disableKeepAlives | boolean | |
disableCompression | boolean | disables (automatic) decompression behavor as documented here |
maxIdleConns | integer | |
maxIdleConnsPerHost | integer | |
maxConnsPerHost | integer | |
maxResponseHeaderBytes | integer | If zero, a default is used |
writeBufferSize | integer | If zero, a default (currently 4KB) is used |
readBufferSize | integer | If zero, a default (currently 4KB) is used |
idleConnTimeout | integer | Duration in Nano Seconds |
CandidateCipherSuite
Field | Type | Description |
---|---|---|
kdfId | string | See possible values at the end of this page |
aeadId | string | See possible values at the end of this page |
PriorityParam
Field | Type | Description |
---|---|---|
streamDep | integer | |
exclusive | boolean | |
weight | integer |
PriorityFrames
Field | Type | Description |
---|---|---|
streamId | integer | |
priorityParam | PriorityParam | See type in the section above |
Cookie Input
Field | Type | Description |
---|---|---|
domain | string | |
expires | integer | Unix Timestamp |
maxAge | integer | Number of seconds the cookie is valid. |
name | string | |
path | string | |
value | string |
If both Expires
and Max-Age
are set, Max-Age
has precedence.
Values
Here you can find the allowed possible string values to supply for fields like supportedDelegatedCredentialsAlgorithms
, supportedSignatureAlgorithms
, supportedVersions
and much more.
H2Settings
Supported Versions
Supported Signature Algorithms
certCompressionAlgorithm
Supported delegated credentials
KeyShareCurves
kdfIds
aeadIds
Last updated