request

request(options: table) -> Response

Sends an HTTP request described by an options table and returns a response table. options.Url is required; Method defaults to GET; Headers, Cookies, and Body are optional. A body is not allowed with GET or HEAD. The response table carries Success, StatusCode, StatusMessage, RawHeaders, Headers, Cookies, and Body. Headers keys keep the casing the server sent. Cookies holds the name and value of every Set-Cookie the response set, except .ROBLOSECURITY. Also registered as http_request.

Parameters

table

required

The request options, with at least a Url.

Returns

Response

A table with Success, StatusCode, StatusMessage, RawHeaders, Headers, Cookies, and Body.

Example

local res = request({
    Url = "https://httpbin.org/post",
    Method = "POST",
    Headers = { ["Content-Type"] = "application/json" },
    Body = '{"hello":"world"}',
})
print(res.StatusCode, res.Body)

Errors

Message	Condition
`the request options table has no Url string`	`Url` was missing or not a string.
`the requested url must start with http:// or https://`	The url scheme was not HTTP(S).
`this host is not permitted for requests`	The host is on the block list.
`a request body is not allowed with GET or HEAD`	A body was set on a GET or HEAD.

httpget: the simple string fetch.

Getting Started

Environment

Closures

Scripts

Reflection

Metatable

Instances

Cache

Signals

Signal

Actors

LuaStateProxy

Console

Input

Drawing

Filesystem

Encoding

Crypt

HTTP

WebSocket

RakNet

Miscellaneous

oth

Parameters

Returns

Example

Errors

​Parameters

​Returns

​Example

​Errors

​Related

Parameters

Returns

Example

Errors

Related