Skip to main content
Version: 8.0.2

HTTP Request

sendGetRequest

Method allowing to send a GET request.

ParameterTypeDescription
urlstringUrl of the targeted request.
configHttpRequestConfig Request configuration.

config

NameTypeDescription
adapterAxiosAdapter
authAxiosBasicCredentials
baseURLstring
cancelTokenCancelToken
dataany
decompressboolean
headersAxiosRequestHeaders
httpAgentany
httpsAgentany
insecureHTTPParserboolean
maxBodyLengthnumber
maxContentLengthnumber
maxRedirectsnumber
methodMethod
onDownloadProgressfunction
onUploadProgressfunction
paramsany
paramsSerializerfunction
proxyAxiosProxyConfig / false
responseEncodingfunction
responseTypeResponseType
signalAbortSignal
socketPathfunction
responseEncodingresponseEncoding / string
socketPathfunction
timeoutnumber
timeoutErrorMessagestring
transformRequestAxiosRequestTransformer / AxiosRequestTransformer[]
transformResponseAxiosResponseTransformer / AxiosResponseTransformer[]
transitionalTransitionalOptions
urlstring
validateStatusfunction
withCredentialsboolean
xsrfCookieNamestring
xsrfHeaderNamestring

Basic Usage

await I.sendGetRequest("https://my-website.com/api/v1");

sendDeleteRequest

Method allowing to send a DELETE request.

ParameterTypeDescription
urlstringUrl of the targeted request.
configHttpRequestConfig Request configuration.

config

NameTypeDescription
adapterAxiosAdapter
authAxiosBasicCredentials
baseURLstring
cancelTokenCancelToken
dataany
decompressboolean
headersAxiosRequestHeaders
httpAgentany
httpsAgentany
insecureHTTPParserboolean
maxBodyLengthnumber
maxContentLengthnumber
maxRedirectsnumber
methodMethod
onDownloadProgressfunction
onUploadProgressfunction
paramsany
paramsSerializerfunction
proxyAxiosProxyConfig / false
responseEncodingfunction
responseTypeResponseType
signalAbortSignal
socketPathfunction
responseEncodingresponseEncoding / string
socketPathfunction
timeoutnumber
timeoutErrorMessagestring
transformRequestAxiosRequestTransformer / AxiosRequestTransformer[]
transformResponseAxiosResponseTransformer / AxiosResponseTransformer[]
transitionalTransitionalOptions
urlstring
validateStatusfunction
withCredentialsboolean
xsrfCookieNamestring
xsrfHeaderNamestring

Basic Usage

await I.sendDeleteRequest("https://my-website.com/api/v1");

sendHeadRequest

Method allowing to send a HEAD request.

ParameterTypeDescription
urlstringUrl of the targeted request.
configHttpRequestConfig Request configuration.

config

NameTypeDescription
adapterAxiosAdapter
authAxiosBasicCredentials
baseURLstring
cancelTokenCancelToken
dataany
decompressboolean
headersAxiosRequestHeaders
httpAgentany
httpsAgentany
insecureHTTPParserboolean
maxBodyLengthnumber
maxContentLengthnumber
maxRedirectsnumber
methodMethod
onDownloadProgressfunction
onUploadProgressfunction
paramsany
paramsSerializerfunction
proxyAxiosProxyConfig / false
responseEncodingfunction
responseTypeResponseType
signalAbortSignal
socketPathfunction
responseEncodingresponseEncoding / string
socketPathfunction
timeoutnumber
timeoutErrorMessagestring
transformRequestAxiosRequestTransformer / AxiosRequestTransformer[]
transformResponseAxiosResponseTransformer / AxiosResponseTransformer[]
transitionalTransitionalOptions
urlstring
validateStatusfunction
withCredentialsboolean
xsrfCookieNamestring
xsrfHeaderNamestring

Basic Usage

await I.sendHeadRequest("https://my-website.com/api/v1");

sendPostRequest

Method allowing to send a POST request.

ParameterTypeDescription
urlstringUrl of the targeted request.
datastringData content of the request.
configHttpRequestConfig Request configuration.

config

NameTypeDescription
adapterAxiosAdapter
authAxiosBasicCredentials
baseURLstring
cancelTokenCancelToken
dataany
decompressboolean
headersAxiosRequestHeaders
httpAgentany
httpsAgentany
insecureHTTPParserboolean
maxBodyLengthnumber
maxContentLengthnumber
maxRedirectsnumber
methodMethod
onDownloadProgressfunction
onUploadProgressfunction
paramsany
paramsSerializerfunction
proxyAxiosProxyConfig / false
responseEncodingfunction
responseTypeResponseType
signalAbortSignal
socketPathfunction
responseEncodingresponseEncoding / string
socketPathfunction
timeoutnumber
timeoutErrorMessagestring
transformRequestAxiosRequestTransformer / AxiosRequestTransformer[]
transformResponseAxiosResponseTransformer / AxiosResponseTransformer[]
transitionalTransitionalOptions
urlstring
validateStatusfunction
withCredentialsboolean
xsrfCookieNamestring
xsrfHeaderNamestring

Basic Usage

await I.sendPostRequest("https://my-website.com/api/v1");

sendPutRequest

Method allowing to send a PUT request.

ParameterTypeDescription
urlstringUrl of the targeted request.
datastringData content of the request.
configHttpRequestConfig Request configuration.

config

NameTypeDescription
adapterAxiosAdapter
authAxiosBasicCredentials
baseURLstring
cancelTokenCancelToken
dataany
decompressboolean
headersAxiosRequestHeaders
httpAgentany
httpsAgentany
insecureHTTPParserboolean
maxBodyLengthnumber
maxContentLengthnumber
maxRedirectsnumber
methodMethod
onDownloadProgressfunction
onUploadProgressfunction
paramsany
paramsSerializerfunction
proxyAxiosProxyConfig / false
responseEncodingfunction
responseTypeResponseType
signalAbortSignal
socketPathfunction
responseEncodingresponseEncoding / string
socketPathfunction
timeoutnumber
timeoutErrorMessagestring
transformRequestAxiosRequestTransformer / AxiosRequestTransformer[]
transformResponseAxiosResponseTransformer / AxiosResponseTransformer[]
transitionalTransitionalOptions
urlstring
validateStatusfunction
withCredentialsboolean
xsrfCookieNamestring
xsrfHeaderNamestring

Basic Usage

await I.sendPutRequest("https://my-website.com/api/v1");

sendPatchRequest

Method allowing to send a PATCH request.

ParameterTypeDescription
urlstringUrl of the targeted request.
datastringData content of the request.
configHttpRequestConfig Request configuration.

config

NameTypeDescription
adapterAxiosAdapter
authAxiosBasicCredentials
baseURLstring
cancelTokenCancelToken
dataany
decompressboolean
headersAxiosRequestHeaders
httpAgentany
httpsAgentany
insecureHTTPParserboolean
maxBodyLengthnumber
maxContentLengthnumber
maxRedirectsnumber
methodMethod
onDownloadProgressfunction
onUploadProgressfunction
paramsany
paramsSerializerfunction
proxyAxiosProxyConfig / false
responseEncodingfunction
responseTypeResponseType
signalAbortSignal
socketPathfunction
responseEncodingresponseEncoding / string
socketPathfunction
timeoutnumber
timeoutErrorMessagestring
transformRequestAxiosRequestTransformer / AxiosRequestTransformer[]
transformResponseAxiosResponseTransformer / AxiosResponseTransformer[]
transitionalTransitionalOptions
urlstring
validateStatusfunction
withCredentialsboolean
xsrfCookieNamestring
xsrfHeaderNamestring

Basic Usage

await I.sendPatchRequest("https://my-website.com/api/v1");