HttpRbxApiService

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

HttpRbxApiService
Not creatableThis class cannot be instantiated. ServiceThis class is a service.
Added in	174 (October 2014)
Memory category	Instances
Inheritance
Object Instance HttpRbxApiService

The HttpRbxApiService class, added in version 0.174, inherits from Instance. It cannot be instantiated.

It is a version of HttpService used by Roblox administrators that can send requests to roblox.com.

Methods

GetAsync(apiUrlPath: string, priority: ThrottlingPriority = Default, httpRequestType: HttpRequestType = Default): string

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

Parameters

Name	Type	Default
apiUrlPath	string
priority	ThrottlingPriority	Default
httpRequestType	HttpRequestType	Default

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetAsyncFullUrl(apiUrl: string, priority: ThrottlingPriority = Default, httpRequestType: HttpRequestType = Default): string

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

Parameters

Name	Type	Default
apiUrl	string
priority	ThrottlingPriority	Default
httpRequestType	HttpRequestType	Default

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

GetDocumentationUrl(partialUrl: string): string

Parameters

Name	Type
partialUrl	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PostAsync(apiUrlPath: string, data: string, priority: ThrottlingPriority = Default, content_type: HttpContentType = ApplicationJson, httpRequestType: HttpRequestType = Default): string

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

Parameters

Name	Type	Default
apiUrlPath	string
data	string
priority	ThrottlingPriority	Default
content_type	HttpContentType	ApplicationJson
httpRequestType	HttpRequestType	Default

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PostAsyncFullUrl(apiUrl: string, data: string, priority: ThrottlingPriority = Default, content_type: HttpContentType = ApplicationJson, httpRequestType: HttpRequestType = Default): string

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

Parameters

Name	Type	Default
apiUrl	string
data	string
priority	ThrottlingPriority	Default
content_type	HttpContentType	ApplicationJson
httpRequestType	HttpRequestType	Default

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

RequestAsync(requestOptions: Dictionary, priority: ThrottlingPriority = Default, content_type: HttpContentType = ApplicationJson, httpRequestType: HttpRequestType = Default): string

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

Parameters

Name	Type	Default
requestOptions	Dictionary
priority	ThrottlingPriority	Default
content_type	HttpContentType	ApplicationJson
httpRequestType	HttpRequestType	Default

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

RequestLimitedAsync(requestOptions: Dictionary, priority: ThrottlingPriority = Default, content_type: HttpContentType = ApplicationJson, httpRequestType: HttpRequestType = Default): string

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

Parameters

Name	Type	Default
requestOptions	Dictionary
priority	ThrottlingPriority	Default
content_type	HttpContentType	ApplicationJson
httpRequestType	HttpRequestType	Default

• Thread safety: unsafe

External links

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