Skip to main content
Version: Streamsheets 2.5

HTTP.OPTIONS

Create an HTTP OPTIONS request. The HTTP OPTIONS method is used to describe communication options for the target resource. Browsers send an HTTP OPTIONS request to find out the supported HTTP methods and other options supported for the target resource before sending the actual request.

Syntax

=HTTP.OPTIONS(URL, [HeadersJSON], [ConfigJSON], [Target])

Arguments

NameDescription
URLThe URL to request.
HeadersJSON (optional)Headers of the HTTP request.
ConfigJSON (optional)A JSON configuration for the HTTP request. Possible configurations are: "baseURL","timeout","auth: { username: 'secret', password: 'tops3cret' }","proxy: {protocol: 'https',host: '127.0.0.1',port: 9000, auth: {username: 'secret', password: 'tops3cret' } "
Target (optional)INBOX(), 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

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

Examples

Select

Examples for using the config and header parameter. Use a JSON() function around the cell range.

FormulaResultComment
=HTTP.OPTIONS("[object Object] ,,,INBOX())
Request to the APIA request has been made and put the response into the inbox.