PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

HttpService

Show deprecated

HttpService

Show deprecated

This service allows HTTP requests to be sent from game servers. This enables users to create integration with a wide range of third party services such as analytics and storage. One exciting prospect for this service is that if you run and manage your own website, and communicate with it from Roblox, it opens the possibility of remote server management and real time communication with the server, through your site.

If the limit of 500 http HttpService/GetAsync|GET / HttpService/PostAsync|POST requests per minute is exceeded, the Service will stall entirely for approximately 30 seconds.

Enabling HTTP requests

HttpService starts off as disabled by default.

To HttpService/HttpEnabled|enable HTTP requests, the HttpService must be enabled through Studio’s Game Settings by opening the game’s settings via the Game Settings button on the Home tab of the game’s studio window (see image below):
Navigate to the Game Settings button

Within the Game Settings window, navigate to the Security tab and select the On option under Allow HTTP Requests (see image below).
Allow HTTP Requests

Usage ideas

  • Cross server marketplace
  • Real time stock market
  • Cross server leaderboard

Restrictions

  • Limit of 500 requests a minute (Per server)
  • This service is not allowed to send requests to any of the Roblox websites such as www.roblox.com or api.roblox.com

See also

See here for a detailed guide on sending HTTP requests.Sending HTTP requests.

Properties

bool

HttpEnabled

Enables requests to external websites.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]

The cost of saving the instance using data persistence.

Instance

Parent

Determines the hierarchical parent of the Instance.

bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to.

string

Name

A non-unique identifier of the Instance.

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

Functions

string

GenerateGUID ( bool wrapInCurlyBraces )

Generates a UUID/GUID random string, optionally with curly braces

string

GetAsync ( string url , bool nocache , Variant headers )

[Yields]

Send an HTTP GET request

Variant

JSONDecode ( string input )

Decodes a JSON string into a Lua table

string

JSONEncode ( Variant input )

Generate a JSON string from a Lua table

string

PostAsync ( string url , string data , HttpContentType content_type , bool compress , Variant headers )

[Yields]

Send an HTTP POST request

Dictionary

RequestAsync ( Dictionary requestOptions )

[Yields]

Sends an HTTP request using any HTTP method given a dictionary of information

string

UrlEncode ( string input )

Replaces URL-unsafe characters with ‘%’ and two hexadecimal characters.

Inherited from Instance: Show Hide

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

bool

IsA ( string className )

Returns true if an Instance's class matches or inherits from a given class

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance.

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.