Skip to main content
Version: Streamsheets 3.0

HTTP.REQUEST

Create an HTTP request. Universal function to use for all HTTP methods. Please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods for more information about the different HTTP methods

Syntax

=HTTP.REQUEST(URL, Method, [Body], [HeadersJSON], [ConfigJSON], [Target])

Arguments

NameTypeDescription
URLStringThe URL to request.
MethodHttpMethodThe HTTP-method of the request.

Options:
"GET": Request a specified resource.
"DELETE": Delete a specified resource.
"HEAD": Analog to GET, but without the response body.
"OPTIONS": Use to describe communication options for a specified target resource.
"POST": Submit an entity to a specified resource.
"PUT": Replace specified target resource with the request payload.
"PATCH": Apply partial modifications to a specified resource.
Body (optional)StringThe body of the request.
HeadersJSON (optional)JSONHeaders of the HTTP request.
ConfigJSON (optional)JSONA JSON with one or more of the following properties:
  • baseURL: string
  • timeout: positive number, timout in milliseconds
  • auth: object with the following properties
    • username: string
    • password: string
  • proxy: object one or more of the following properties
    • protocol: string, "http" or "https"
    • host: string, hostname or IP of the proxy server
    • port: number
    • auth: object with the following properties
      • username: string
      • password: string
Target (optional)TargetINBOX(), OUTBOX("MsgID") or a cell range where the result will be placed. Make sure the cell range is big enough or not everything is displayed.

Return

TypeDescription
NumberThe function HTTP.OPTIONS() always returns a unique random request ID. Otherwise an error is displayed.

Examples