request - Real Function Reference

request(options: RequestOptions): Response | string

Alias

http_request
http.request

Arguments

RequestOptions

requis

Request options table. Url is required; Method, Headers, Cookies, and Body are optional.

Retours

Response | string

On request error, an error string. Otherwise a response table.

Types

RequestOptions

Definit la table options lue par request.

Name	Type	Required	Description
`Url`	`string`	Yes	Required HTTP or HTTPS URL. The value must start with http:// or https:// and must not match the blocked URL list.
`Method`	`"GET" \| "POST" \| "PUT" \| "PATCH" \| "DELETE"`	No	Optional method. Defaults to GET. Accepted values after ASCII lowercase normalization are GET, POST, PUT, PATCH, and DELETE.
`Headers`	`{[string]: string}`	No	Optional table of request headers. Keys and values are checked with Lua runtime and rejected if they contain CR or LF. Host, Connection, Content-Length, and Cookie are not forwarded directly.
`Cookies`	`{[string]: string}`	No	Optional table of cookies. Keys and values are checked with Lua runtime and rejected if they contain CR or LF, then merged into the outgoing Cookie header.
`Body`	`string`	No	Optional request body copied with string conversion. The body is only passed to HTTP request client when it is not empty.

Response

Definit la table response renvoyee par request sans request error.

Name	Type	Required	Description
`Success`	`boolean`	Yes	Boolean set to true when StatusCode is between 200 and 299 inclusive.
`StatusCode`	`integer`	Yes	Integer HTTP status code from HTTP status code.
`Body`	`string`	Yes	Response body string from HTTP response body.
`StatusMessage`	`string`	Yes	Status reason string from HTTP status message.
`RawHeaders`	`string`	Yes	Raw header text recondata structureed by the function from the status line, response headers, and Set-Cookie values.
`Headers`	`{[string]: string}`	Yes	Table parsed from RawHeaders by splitting lines on the first colon. Later duplicate names overwrite earlier values.
`Cookies`	`{[string]: string}`	Yes	Table parsed from Set-Cookie lines.ROBLOSECURITY is skipped.

Exemple

Send a GET request and handle either the response table or the request error string.

local response = request({
    Url = "https://example.com/api/status",
    Method = "GET",
})

if type(response) == "table" then
    if response.Success then
        print(response.StatusCode, response.Body)
    else
        warn(response.StatusMessage)
    end
else
    warn(response)
end

​Alias

​Arguments

​Retours

​Types

​RequestOptions

​Response

​Exemple

Alias

Arguments

Retours

Types

RequestOptions

Response

Exemple