All Roblox APIs no longer have the /docs/ page

[TheReal4Cedar123 (Cedar)]

Hi there,

As of recently none of the web APIs have documentation pages, originally it showed you what APIs there are under each subdomain and a way to test them, an example below:

Today when viewing them it shows either a 404 page or a JSON error saying {'errors':[{'code':9009,'message':'No Service Found'}]}


The current APIs that have no docs are:

API Endpoints	Description
abtesting.roblox.com/docs	Endpoints for the A/B Testing framework
accountinformation.roblox.com/docs	All endpoints for accessing/modifying account information
accountsettings.roblox.com/docs	All endpoints for account/user settings
adconfiguration.roblox.com/docs	Roblox Ad Configuration related endpoints
ads.roblox.com/docs	Ads configuration endpoints
assetdelivery.roblox.com/docs	Serves asset content
Authentication Api	All endpoints that tamper with authentication sessions
avatar.roblox.com/docs	Endpoints relating to the customization of player avatars
badges.roblox.com/docs	Endpoints for badges and badge awards management
billing.roblox.com/docs	Real money transactions and interaction
catalog.roblox.com/docs	Catalog items browsing and searching. Content and user based catalog items recommendations
chat.roblox.com/docs	All chat and party related endpoints
clientsettings.roblox.com/docs	Used by various Roblox clients to retrieve configuration information
clientsettingscdn.roblox.com/docs	Used by various Roblox clients to retrieve configuration information
client-telemetry.roblox.com/docs	Handles client telemtry
contentstore.roblox.com/docs	ApiSite to front the TemporaryStore for files before uploading to S3
contacts.roblox.com/docs	Contacts and userTag management
develop.roblox.com/docs	Game development configuration endpoints
economy.roblox.com/docs	Endpoints related to transactions and currency
economycreatorstats.roblox.com/docs	Roblox.EconomyCreatorStats.Api endpoints.
engagementpayouts.roblox.com/docs	For engagement-based payout information
ephemeralcounters.api.roblox.com/docs	Handles ephemeral counters
followings.roblox.com/docs	Establishes follow relationship between subscriber entities (users, groups, etc) and source entities (games, groups, assets, etc.)
friends.roblox.com/docs	Friends, followers, and contacts management
gameinternationalization.roblox.com/docs	Manages internationalization of games such as translating in game content.
gamejoin.roblox.com/docs	All endpoints around launching a game
gamepersistence.roblox.com/docs	Endpoints for the in-game datastore system for storing data for games
games.roblox.com/docs	All endpoints for game discovery, and details
groups.roblox.com/docs	Groups management
groupsmoderation.roblox.com/docs	Group Moderation
inventory.roblox.com/docs	All endpoints for viewing (but not granting) ownership of items
itemconfiguration.roblox.com/docs	Configure Items (bundles and avatar assets)
lms.roblox.com/docs	Status of the Latency Management Service
locale.roblox.com/docs	User locale management
localizationtables.roblox.com/docs	Handles managing of localization tables
metrics.roblox.com/docs	Record metrics across Roblox
notifications.roblox.com/docs	All notification stream endpoints
points.roblox.com/docs	The web Api for the in-game PointsService
premiumfeatures.roblox.com/docs	This API is for premium features and anything pertaining to account add ons
presence.roblox.com/docs	All endpoints for managing presence
privatemessages.roblox.com/docs	All messages page endpoints
publish.roblox.com/docs	All endpoints handling file uploads
realtime.roblox.com/docs	Purpose of API here
share.roblox.com/docs	Purpose of Api here
search.roblox.com/docs	Legacy item search endpoints.
textfilter.roblox.com/docs	High volume text filtering
thumbnails.roblox.com/docs	Endpoints for requesting thumbnails
thumbnailsresizer.roblox.com/docs	Validate and resize thumbnails to requested dimensions
trades.roblox.com/docs	Endpoints for trading collectible items
translationroles.roblox.com/docs	Manages translation roles of developers in game localization
translations.roblox.com/docs	Endpoints for requesting translations
twostepverification.roblox.com/docs	Platform interface for the two step verification system
usermoderation.roblox.com/docs	Endpoints for performing actions/operations related to User Moderation
users.roblox.com/docs	APIs for direct Roblox user information.
voice.roblox.com/docs	APIs for Voice calls

[HealthyKarl]

You can append an additional / until they fix it

e.g.

[TheReal4Cedar123 (Cedar)]

For me it shows 404 still?

[LegendOJ1 (Owen)]

This has been reported here but unfortunately no word of a fix yet. Above looks like the workaround, @HealthyKarl might be worth dropping this in the thread below as Roblox has acknowledged it.

Swagger docs are no longer available on most, but not all subdomains

This issue appears to have surfaced after the Roblox outage earlier today however given that https://status.roblox.com specifies that everything is ‘operational’, I’m assuming that the outage has passed and this is either something that was overlooked or something that the team is aware of and investigating separately of the outage. Navigating to most swagger docs pages on the website (such as https://games.roblox.com/docs) results in a 404 page. This 404 page is different from the 404 page you…

[LegendOJ1 (Owen)]

Try Swagger UI.

[TheReal4Cedar123 (Cedar)]

It seems like a double slash makes it works… Very strange

[HealthyKarl]

If it doesn’t work, I am not sure… does your browser convert the // back to / ?

SUBDOMAIN.ROBLOX.COM then you add the //

It was one of the first things I tried. It was a guess.

Basically, let’s just say that I believe and thought about how servers redirect, look things up and read your URL. There must have been a misconfiguration somewhere, and I think I just pinpointed it.

[Hooksmith]

The documentation has moved here: https://create.roblox.com/docs/cloud/legacy

The new pages list all API documentation that was previously available via direct docs URLs on the respective API sites, to the best of our knowledge. Please let us know if anything is missing that was available before.

You can find all these APIs in the left navigation. It also calls out on the overview page certain APIs that you can hit with legacy OAuth 2.0 / API key scopes instead of with a cookie.

---

Please rely on this new documentation page instead of the old documentation URLs since we cannot offer guarantees that the old URLs will stay available, including any variation (like the double slash workaround), for involved technical reasons.

---

While we do our best to alert you of breaking changes, please note that these legacy APIs may change without notice and break your application and do not have the stability guarantees of the newer Open Cloud APIs.

We especially discourage using the endpoints that only take cookie authentication as much as feasible for your use case, as cookies do not offer fine-grained authorization via scopes.

---

We are looking into improvements to the new documentation pages, like having a way to download the openAPI JSON for each surface, and we are investigating what it would take to support “try out”-esque features on this page.

---

You can let us know here or by filing a new bug report or feature request if you have any feedback, questions or concerns. We’ll do our best to take that into account for any changes we plan to the documentation.

[1QU_RST]

Is there any reason why they’ve changed?

[GalacticInspired (Galactic)]

This does not seem to of fixed this issue?

Was the double-slash intentionally thrown in to tell developers there’s nothing here?

[TheReal4Cedar123 (Cedar)]

It’s moved fully to the docs, Swagger is no longer being used

[Hooksmith]

All info you need is in my previous reply, I recommend giving it another thorough read. Use the new documentation resource instead going forward.

Also make sure to read:

we cannot offer guarantees that the old URLs will stay available, including any variation (like the double slash workaround), for involved technical reasons.

[GalacticInspired (Galactic)]

This isn’t the documentation page, this is the landing pages for the API’s themselves. From what you are saying, all root pages are part of Swagger and hence will not return { message: "OK } anymore.

While I understand that you would not like us using these legacy API’s anymore, I find it important that “/” still returns a 200 status as this may trigger false positives in possible status trackers and break many developer’s outdated applications.

For example, chatmoderation.roblox.com still returns a 200 status instead of a 404.

[Hooksmith]

What is your use case here? Can you show me a product that is broken because of root domain not returning any result? I am aware of one (Mantle) and have worked with them to suggest a fix.

(FWIW, I don’t think iterating API surfaces is a valid use case, our new documentation page fulfils that use case for legacy APIs.)

chatmoderation.roblox.com has never had any swagger documentation exposed.

It should not be expected behavior that the root domain serves any particular response, we have never given out any guarantees about this nor is this used in our own first-party code, so I strongly discourage any dependency on that.

[GalacticInspired (Galactic)]

I can’t really list any public products, however applications we have worked on rely on a response from some API’s to acknowledge they are online and working to guarantee availability

While I understand that pinging the surfaces of API’s is bad practice, there’s still developer’s that require the surface to reply orderly for the app to work right. Sure, there’s other solutions, but abruptly killing off the surface just make’s it harder for said developers to find a different solution.

We had to face downtime due to said issue, and were not able to find the direct cause until looking deeper into the issue, which is auth.roblox.com’s surface sending back a 404. I will take another look at the documentation, however I just don’t think it’s right for the surface to be returning a 404 “File Not Found” error. At the same time, any other invalid path returns a properly formatted json error. It seems out of order for an API.

[Hooksmith]

Let me discuss internally and report back, I understand for you it might have been an unexpected change even though this is a hyper implementation detail of the way we host our APIs. It’s not likely we can revert this due to some emergent technical constraints on our side, but maybe we can broadcast about this difference a bit more widely retroactively at least.

[moo1210]

I depend on accessing the JSON files at /docs/json to generate API clients, please don’t remove these. You’re randomly breaking links that have existed for years, and now adding a replacement that doesn’t give you an easy way to access the JSON files via a static URL.

[Hooksmith]

Thanks for the feedback, actively aware of this and we’re adding JSON viewing/downloading back soon on the new docs resource. This is being worked on right now and expected to ship soon.

Apologies for the gap – we had to move fast here with migration due to an evolving technical issue. We definitely generally want to avoid breakage like this when we can.