Payload

This page shows once the full possible request payload against the shared library, with all default values.

Basic Request Input

{
  "catchPanics": false,
  "certificatePinningHosts": null,
  "customTlsClient": null,
  "transportOptions": null,
  "followRedirects": false,
  "forceHttp1": false,
  "headerOrder": null,
  "headers": null,
  "insecureSkipVerify": false,
  "isByteRequest": false,
  "isByteResponse": false,
  "isRotatingProxy": false,
  "proxyUrl": null,
  "requestBody": null,
  "requestCookies": null,
  "requestHostOverride": null,
  "defaultHeaders": null,
  "connectHeaders": null,
  "requestMethod": "",
  "requestUrl": "",
  "disableIPV6": false,
  "disableIPV4": false,
  "localAddress": null,
  "sessionId": null,
  "serverNameOverwrite": "";
  "streamOutputBlockSize": null,
  "streamOutputEOFSymbol": null,
  "streamOutputPath": null,
  "timeoutMilliseconds": 0,
  "timeoutSeconds": 0,
  "tlsClientIdentifier": "",
  "withDebug": false,
  "withDefaultCookieJar": false,
  "withoutCookieJar": false,
  "withRandomTLSExtensionOrder": false
}

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:"

connectHeaders

Map<string,Array<string>>

Headers to be used during the CONNECT request.

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 the timeoutSeconds can not be changed during a session.

  • followRedirects and proxyUrl can be changed within a session.

  • If you do not want to set requestBody or proxyUrl use null instead of empty string

  • When you set isByteResponse to true the response body will be a base64 encoded string. Useful when you want to download images for example.

  • When you set isByteRequest to true the request body needs to be a base64 encoded string. Useful when you want to upload images for example.

Custom TLS-Client

{
  "certCompressionAlgo": "",
  "connectionFlow": 0,
  "h2Settings": null,
  "h2SettingsOrder": null,
  "headerPriority": null,
  "ja3String": "",
  "keyShareCurves": null,
  "priorityFrames": null,
  "alpnProtocols": null,
  "alpsProtocols": null,
  "ECHCandidatePayloads": null,
  "ECHCandidateCipherSuites": null,
  "pseudoHeaderOrder": null,
  "supportedDelegatedCredentialsAlgorithms": null,
  "supportedSignatureAlgorithms": null,
  "supportedVersions": null
}
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

{
  "disableKeepAlives": false,
  "disableCompression": false,
  "maxIdleConns": 0,
  "maxIdleConnsPerHost": 0,
  "maxConnsPerHost": 0,
  "maxResponseHeaderBytes": 0,
  "writeBufferSize": 0,
  "readBufferSize": 0,
  "idleConnTimeout": 0,
}
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

{
    "kdfId": "",
    "aeadId": "",
}
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

{
    "streamDep": 0,
    "exclusive": false,
    "weight": 0
}
Field
Type
Description

streamDep

integer

exclusive

boolean

weight

integer

PriorityFrames

{
    "streamID": 0,
    "priorityParam": null
}
Field
Type
Description

streamId

integer

priorityParam

PriorityParam

See type in the section above

Cookie Input

{
  "domain": "",
  "expires": 0,
  "maxAge": 0,
  "name": "",
  "path": "",
  "value": ""
}
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

"HEADER_TABLE_SIZE",
"ENABLE_PUSH",
"MAX_CONCURRENT_STREAMS",
"INITIAL_WINDOW_SIZE",
"MAX_FRAME_SIZE",
"MAX_HEADER_LIST_SIZE",

Supported Versions

"GREASE",
"1.3",
"1.2",
"1.1",
"1.0",

Supported Signature Algorithms

"PKCS1WithSHA256",
"PKCS1WithSHA384",
"PKCS1WithSHA512",
"PSSWithSHA256",
"PSSWithSHA384",
"PSSWithSHA512",
"ECDSAWithP256AndSHA256",
"ECDSAWithP384AndSHA384",
"ECDSAWithP521AndSHA512",
"PKCS1WithSHA1",
"ECDSAWithSHA1",
"Ed25519",

certCompressionAlgorithm

"zlib",
"brotli",
"zstd",

Supported delegated credentials

"PKCS1WithSHA256",
"PKCS1WithSHA384",
"PKCS1WithSHA512",
"PSSWithSHA256",
"PSSWithSHA384",
"PSSWithSHA512",
"ECDSAWithP256AndSHA256",
"ECDSAWithP384AndSHA384",
"ECDSAWithP521AndSHA512",
"PKCS1WithSHA1",
"ECDSAWithSHA1",
"Ed25519",
"SHA224_RSA",
"SHA224_ECDSA"

KeyShareCurves

"GREASE",
"P256",
"P384",
"P521",
"X25519",
"P256Kyber768",
"X25519Kyber512D",
"X25519Kyber768",

kdfIds

"HKDF_SHA256",
"HKDF_SHA384",
"HKDF_SHA512",

aeadIds

"AEAD_AES_128_GCM",
"AEAD_AES_256_GCM",
"AEAD_CHACHA20_POLY1305",

PreviousDefaultsNextResponse

Last updated