Full Documentation for Status+, DowntimeService, and more!
Welcome to the Documentation for Status+! Here is where you will find how to use our in-game API, DowntimeService, along with other useful information and API endpoints. This is the most updated place with all the information. If there is a mistake, please make a new issue so I can look into it!
DowntimeService is the in-game API for Status+. It can be used to check if Roblox’s services are up or down, all doing so in-game. This can be used to prevent players from doing actions that may not work, such as attempting to use an In-Game avatar editor or to teleport to a different place.
Setup:
To set up DowntimeService, you can:
Require the module by it’s ID in a ServerScript. (6317978171)
Grab the examples and Module as a .rbxm under releases (Here)
Best Practices:
Try not to call each funciton too many times. It’s using HttpService, which does have limits.
There is no need to call any functions super fast, they only update every 5 minutes anyway.
Don’t even try this outside a ServerScript. (Unless your a fan of error-spams!)
Example Code:
local DowntimeService = require(6317978171) -- Or require by using the file path. (Requiring by ID is better for quicker updates.)
local Players = game:GetService("Players")
-- Example #1: Kicking Players if Datastores are down.
Players.PlayerAdded:Connect(function(player)
if DowntimeService:GetDatastoreAPIStatus() == "down" then
player:Kick("Datastores are currently down. To prevent critical errors we have kicked you. If this issue persits please contact the game owner. =")
end
end)
-- Example #2 Printing latest tests if something is down or not.
while true do
if DowntimeService:GetSiteStatus() == "down" then
warn("Roblox Website is Currently Down! Please be patient while Roblox works on a fix! :)")
elseif DowntimeService.GetSiteStatus() == "degraded" then
print("Roblox Website is Currently slow! Please be patient while Roblox works on it! :)")
elseif DowntimeService:GetSiteStatus() == "up" then
print("Roblox website is currently up!")
end
wait(300)
end
.GetRobloxStatus()Returns "up", "degraded", or "down" based on the status of every single API endpoint tracked by Status+.
Example Use:
DowntimeService.GetRobloxStatus() -- returns "up" if all API's are up, "down" if at least one API is down, and "degraded" if at least one API is degraded.
.GetSiteStatus()Returns "up", "degraded", or "down" based on the status of the Roblox site.
Example Use:
DowntimeService.GetSiteStatus() -- returns "up" if the site is up, "down" if the site is down, and "degraded" if the site is slow.
.GetDevForumStatus()Returns "up", "degraded", or "down" based on the status of the Roblox Developer Forum.
Example Use:
DowntimeService.GetDevForumStatus() -- returns "up" if the forum is up, "down" if the forum is down, and "degraded" if the forum is slow.
.GetDevHubStatus()Returns "up", "degraded", or "down" based on the status of the Roblox Developer Hub
Example Use:
DowntimeService.GetDevHubStatus() -- returns "up" if the devhub is up, "down" if the devhub is down, and "degraded" if the devhub is slow.
.GetAvatarAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Avatar API.
Example Use:
DowntimeService.GetAvatarAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetBadgesAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Badge API.
Example Use:
DowntimeService.GetBadgesAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetCDNAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s CDN API.
Example Use:
DowntimeService.GetCDNAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetCatalogAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Catalog API.
Example Use:
DowntimeService.GetCatalogAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetDatastoreAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Datastore API.
Example Use:
DowntimeService.GetDatastoreAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetDevelopAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Develop API.
Example Use:
DowntimeService.GetDevelopAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetEconomyAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Economy API.
Example Use:
DowntimeService.GetEconomyAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetFriendsAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Friends API.
Example Use:
DowntimeService.GetFriendsAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetGameJoinAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s GameJoin API.
Example Use:
DowntimeService.GetGameJoinAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetGameInternationalizationAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Game Internationalization API.
Example Use:
DowntimeService.GetGameJoinAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetGroupsAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Groups API.
Example Use:
DowntimeService.GetGroupsAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetInventoryAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Inventory API.
Example Use:
DowntimeService.GetInventoryAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetTextFilterAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Text Filter API.
Example Use:
DowntimeService.GetTextFilterAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
.GetThumbnailsAPIStatus()Returns "up", "degraded", or "down" based on the status of Roblox’s Thumbnails API.
Example Use:
DowntimeService.GetThumbnailsAPIStatus() -- returns "up" if the API is up, "down" if the API is down, and "degraded" if the API is slow.
The API for the Status Site is simple. You can find it under the /api folder under it’s GitHub repo.
There is currently only one way of getting the current status through API, however this is being worked on. If you need to get the current status, please use Summary.json.