HttpRbxApiService

Show Deprecated
Not Creatable
Service

A version of the HttpService used by the admins. Unlike the regular service, this one can send GET/POST requests to roblox.com

Summary

Properties

Events

Methods

GetAsync(apiUrlPath: string, priority: ThrottlingPriority, httpRequestType: HttpRequestType): string  YIELDS

Performs a GET request on an official Roblox web API.

GetAsyncFullUrl(apiUrl: string, priority: ThrottlingPriority, httpRequestType: HttpRequestType): string  YIELDS


PostAsync(apiUrlPath: string, data: string, priority: ThrottlingPriority, content_type: HttpContentType, httpRequestType: HttpRequestType): string  YIELDS

Performs a POST request to the specified Roblox Web API The apiUrlPath parameter is prefixed by https://api.roblox.com/ when the post request is made.

PostAsyncFullUrl(apiUrl: string, data: string, priority: ThrottlingPriority, content_type: HttpContentType, httpRequestType: HttpRequestType): string  YIELDS


RequestAsync(requestOptions: table, priority: ThrottlingPriority, content_type: HttpContentType, httpRequestType: HttpRequestType): string  YIELDS


RequestLimitedAsync(requestOptions: table, priority: ThrottlingPriority, content_type: HttpContentType, httpRequestType: HttpRequestType): string  YIELDS


Properties

Events

Methods

GetDocumentationUrl

Roblox Script Security

Parameters

partialUrl: string

Returns

GetAsync

Yields
Roblox Script Security

Performs a GET request on an official Roblox web API

Parameters

apiUrlPath: string
Default Value: "Default"
httpRequestType: HttpRequestType
Default Value: "Default"

Returns

GetAsyncFullUrl

Yields
Roblox Script Security

Parameters

apiUrl: string
Default Value: "Default"
httpRequestType: HttpRequestType
Default Value: "Default"

Returns

PostAsync

Yields
Roblox Script Security

Performs a POST request to the specified Roblox Web API. The apiUrlPath parameter is prefixed by "https://api.roblox.com/" when the post request is made.

Parameters

apiUrlPath: string
data: string
Default Value: "Default"
content_type: HttpContentType
Default Value: "ApplicationJson"
httpRequestType: HttpRequestType
Default Value: "Default"

Returns

PostAsyncFullUrl

Yields
Roblox Script Security

Parameters

apiUrl: string
data: string
Default Value: "Default"
content_type: HttpContentType
Default Value: "ApplicationJson"
httpRequestType: HttpRequestType
Default Value: "Default"

Returns

RequestAsync

Yields
Roblox Script Security

Parameters

requestOptions: table
Default Value: "Default"
content_type: HttpContentType
Default Value: "ApplicationJson"
httpRequestType: HttpRequestType
Default Value: "Default"

Returns

RequestLimitedAsync

Yields

Parameters

requestOptions: table
Default Value: "Default"
content_type: HttpContentType
Default Value: "ApplicationJson"
httpRequestType: HttpRequestType
Default Value: "Default"

Returns