Client Settings v1

Reference for the Client Settings v1 endpoints on Roblox.

Base URL: https://clientsettings.roblox.com

Endpoints

Method	Path	Name
GET	/v1/client-version/:binaryType	getClientVersionBinarytype
GET	/v1/installer-cdns	getInstallerCdns
GET	/v1/mobile-client-version	getMobileClientVersion

getClientVersionBinarytype

GET /v1/client-version/:binaryType

Get client version information for specific binary type

Usage

import { fetchApi } from 'rozod';
import { getClientVersionBinarytype } from 'rozod/endpoints/clientsettingsv1';

const data = await fetchApi(getClientVersionBinarytype, {
  binaryType: /* string */
});

Parameters

Name	Type	Required	Description
binaryType	string	Yes	Platform(WindowsPlayer, WindowsStudio, MacPlayer or MacStudio) for which we want the latest version

Response

Field	Type	Description
version	string
clientVersionUpload	string
bootstrapperVersion	string
nextClientVersionUpload	string
nextClientVersion	string
forceInstall	boolean

---

getInstallerCdns

GET /v1/installer-cdns

Get information about which CDNs to use for installation.

Usage

import { fetchApi } from 'rozod';
import { getInstallerCdns } from 'rozod/endpoints/clientsettingsv1';

const data = await fetchApi(getInstallerCdns, undefined);

Response

Type: unknown

---

getMobileClientVersion

GET /v1/mobile-client-version

Get mobile client version information based on app version parameter

Usage

import { fetchApi } from 'rozod';
import { getMobileClientVersion } from 'rozod/endpoints/clientsettingsv1';

const data = await fetchApi(getMobileClientVersion, {
  appVersion: /* string */
});

Parameters

Name	Type	Required	Description
appVersion	string	Yes	AppiOSV2.13, AppVersioniOS2.0.1, etc

Response

Field	Type	Description
activeVersion	string
upgradeSource	string
MD5Sum	string
data	object	See below

data fields:

Field	Type	Description
UpgradeAction	string

Errors

Status	Description
400	2: Invalid binaryType.

---