HttpService

HttpService
Not creatableThis class cannot be instantiated. ServiceThis class is a service.
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Added in	122 (September 2013)
Memory category	Instances
Inheritance
Object Instance HttpService

The HttpService class, added in version 0.122, inherits from Instance. It cannot be instantiated. HTTP requests were enabled on December 12, 2013.

Properties

HttpEnabled: bool

Determines whether or not in-experience HTTP requests are enabled.

• Category: Data.
• Write security: LocalUserSecurity.
• Serialization: can save and load.
• Thread safety: read safe

Methods

CreateWebStreamClient(streamClientType: WebStreamClientType, requestOptions: Dictionary): WebStreamClient

This class member is missing documentation. Create or add to its subpage at Class:HttpService/CreateWebStreamClient.

• Thread safety: unsafe

CreateWebStreamClientInternal(streamClientType: WebStreamClientType, requestOptions: Dictionary): WebStreamClient

This class member is missing documentation. Create or add to its subpage at Class:HttpService/CreateWebStreamClientInternal.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GenerateGUID(wrapInCurlyBraces: bool = true): string

Parameters

Name	Type	Default	Description
wrapInCurlyBraces	bool	true	Whether or not to wrap the newly-generated GUID in curly braces.

Generates a GUID.

• Thread safety: safe

GetAsync(url: Variant, nocache: bool = false, headers: Variant): string

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
url	Variant
nocache	bool	false
headers	Variant

• Thread safety: unsafe

GetHttpEnabled(): bool

This class member is missing documentation. Create or add to its subpage at Class:HttpService/GetHttpEnabled.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetSecret(key: string): Secret

Parameters

Name	Type
key	string

• Thread safety: safe

GetUserAgent(): string

This class member is missing documentation. Create or add to its subpage at Class:HttpService/GetUserAgent.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

JSONDecode(input: string): Variant

• Custom Lua stateThis member uses the Lua C API directly.

Parameters

Name	Type
input	string

• Thread safety: safe

JSONDecodeAsync(input: string): Variant

• YieldsThis function can yield the script it is used in.

This class member is missing documentation. Create or add to its subpage at Class:HttpService/JSONDecodeAsync.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

JSONEncode(input: Variant): string

• Custom Lua stateThis member uses the Lua C API directly.

This method converts the provided table into a JSON table via a string.

Parameters

Name	Type
input	Variant

• Thread safety: safe

JSONEncodeAsync(obj: Variant): string

• YieldsThis function can yield the script it is used in.

This class member is missing documentation. Create or add to its subpage at Class:HttpService/JSONEncodeAsync.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PostAsync(url: Variant, data: string, content_type: HttpContentType = ApplicationJson, compress: bool = false, headers: Variant): string

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
url	Variant
data	string
content_type	HttpContentType	ApplicationJson
compress	bool	false
headers	Variant

• Thread safety: unsafe

RequestAsync(requestOptions: Dictionary): Dictionary

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
requestOptions	Dictionary

• Thread safety: unsafe

RequestInternal(options: Dictionary): Instance

Parameters

Name	Type
options	Dictionary

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SetHttpEnabled(enabled: bool): null

Parameters

Name	Type
enabled	bool

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

UrlEncode(input: string): string

Parameters

Name	Type
input	string

• Thread safety: safe

External links

• HttpService in the Roblox Creator Documentation
• HttpService in the Roblox API Reference