Matchmaking v1

Reference for the Matchmaking v1 endpoints on Roblox.

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

Endpoints

Method	Path	Name
GET	/v1/client-status	getClientStatus
POST	/v1/client-status	postClientStatus
POST	/v1/game-instances/shutdown	postGameInstancesShutdown
POST	/v1/game-instances/shutdown-all	postGameInstancesShutdownAll
POST	/v1/matchmaking/player-attribute	postMatchmakingPlayerAttribute
DELETE	/v1/matchmaking/player-attribute/:attributeId	deleteMatchmakingPlayerAttributeAttributeid
PATCH	/v1/matchmaking/player-attribute/:attributeId	patchMatchmakingPlayerAttributeAttributeid
GET	/v1/matchmaking/player-attributes/:universeId	getMatchmakingPlayerAttributesUniverseid
POST	/v1/matchmaking/scoring-configuration	postMatchmakingScoringConfiguration
GET	/v1/matchmaking/scoring-configuration/:scoringConfigurationId	getMatchmakingScoringConfigurationScoringconfigurationid
DELETE	/v1/matchmaking/scoring-configuration/:scoringConfigurationId	deleteMatchmakingScoringConfigurationScoringconfigurationid
PATCH	/v1/matchmaking/scoring-configuration/:scoringConfigurationId	patchMatchmakingScoringConfigurationScoringconfigurationid
POST	/v1/matchmaking/scoring-configuration/:scoringConfigurationId/signals	postMatchmakingScoringConfigurationScoringconfigurationidSignals
DELETE	/v1/matchmaking/scoring-configuration/:scoringConfigurationId/signals/:signalName	deleteMatchmakingScoringConfigurationScoringconfigurationidSignalsSignalname
PATCH	/v1/matchmaking/scoring-configuration/:scoringConfigurationId/signals/:signalName	patchMatchmakingScoringConfigurationScoringconfigurationidSignalsSignalname
GET	/v1/matchmaking/scoring-configuration/default-weights	getMatchmakingScoringConfigurationDefaultWeights
POST	/v1/matchmaking/scoring-configuration/place	postMatchmakingScoringConfigurationPlace
DELETE	/v1/matchmaking/scoring-configuration/place/:placeId	deleteMatchmakingScoringConfigurationPlacePlaceid
GET	/v1/matchmaking/scoring-configurations/:universeId	getMatchmakingScoringConfigurationsUniverseid
GET	/v1/matchmaking/scoring-configurations/:universeId/places	getMatchmakingScoringConfigurationsUniverseidPlaces
POST	/v1/matchmaking/server-attribute	postMatchmakingServerAttribute
DELETE	/v1/matchmaking/server-attribute/:attributeId	deleteMatchmakingServerAttributeAttributeid
PATCH	/v1/matchmaking/server-attribute/:attributeId	patchMatchmakingServerAttributeAttributeid
GET	/v1/matchmaking/server-attributes/:universeId	getMatchmakingServerAttributesUniverseid
GET	/v1/matchmaking/universe/:universeId/feature-flags	getMatchmakingUniverseUniverseidFeatureFlags

getClientStatus

GET /v1/client-status

Get the client-status

Usage

import { fetchApi } from 'rozod';
import { getClientStatus } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(getClientStatus, undefined);

Response

Type: unknown

---

postClientStatus

POST /v1/client-status

Set the client-status

Usage

import { fetchApi } from 'rozod';
import { postClientStatus } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(postClientStatus, undefined);

Response

Type: unknown

---

postGameInstancesShutdown

POST /v1/game-instances/shutdown

Shutdown game instances.

Usage

import { fetchApi } from 'rozod';
import { postGameInstancesShutdown } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(postGameInstancesShutdown, undefined);

Response

Type: unknown

---

postGameInstancesShutdownAll

POST /v1/game-instances/shutdown-all

Shutdown all game instances.

Usage

import { fetchApi } from 'rozod';
import { postGameInstancesShutdownAll } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(postGameInstancesShutdownAll, undefined);

Response

Type: unknown

---

postMatchmakingPlayerAttribute

POST /v1/matchmaking/player-attribute

Create a PlayerAttributeDefinition.

Usage

import { fetchApi } from 'rozod';
import { postMatchmakingPlayerAttribute } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(postMatchmakingPlayerAttribute, undefined);

Response

Type: unknown

---

deleteMatchmakingPlayerAttributeAttributeid

DELETE /v1/matchmaking/player-attribute/:attributeId

Delete the PlayerAttributeDefinition specified by attributeId.

Usage

import { fetchApi } from 'rozod';
import { deleteMatchmakingPlayerAttributeAttributeid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(deleteMatchmakingPlayerAttributeAttributeid, {
  attributeId: /* unknown */
});

Parameters

Name	Type	Required	Description
attributeId	unknown	Yes

Response

Type: unknown

---

patchMatchmakingPlayerAttributeAttributeid

PATCH /v1/matchmaking/player-attribute/:attributeId

Update the PlayerAttributeDefinition specified by attributeId.

Usage

import { fetchApi } from 'rozod';
import { patchMatchmakingPlayerAttributeAttributeid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(patchMatchmakingPlayerAttributeAttributeid, {
  attributeId: /* unknown */
});

Parameters

Name	Type	Required	Description
attributeId	unknown	Yes

Response

Type: unknown

---

getMatchmakingPlayerAttributesUniverseid

GET /v1/matchmaking/player-attributes/:universeId

List all PlayerAttributeDefinitions of a universe.

Usage

import { fetchApi } from 'rozod';
import { getMatchmakingPlayerAttributesUniverseid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(getMatchmakingPlayerAttributesUniverseid, {
  universeId: /* unknown */
});

Parameters

Name	Type	Required	Description
universeId	unknown	Yes

Response

Type: unknown

---

postMatchmakingScoringConfiguration

POST /v1/matchmaking/scoring-configuration

Creates a matchmaking scoring configuration.

Usage

import { fetchApi } from 'rozod';
import { postMatchmakingScoringConfiguration } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(postMatchmakingScoringConfiguration, undefined);

Response

Type: unknown

---

getMatchmakingScoringConfigurationScoringconfigurationid

GET /v1/matchmaking/scoring-configuration/:scoringConfigurationId

Updates a matchmaking scoring configuration.

Usage

import { fetchApi } from 'rozod';
import { getMatchmakingScoringConfigurationScoringconfigurationid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(getMatchmakingScoringConfigurationScoringconfigurationid, {
  scoringConfigurationId: /* unknown */
});

Parameters

Name	Type	Required	Description
scoringConfigurationId	unknown	Yes

Response

Type: unknown

---

deleteMatchmakingScoringConfigurationScoringconfigurationid

DELETE /v1/matchmaking/scoring-configuration/:scoringConfigurationId

Deletes a matchmaking scoring configuration.

Usage

import { fetchApi } from 'rozod';
import { deleteMatchmakingScoringConfigurationScoringconfigurationid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(deleteMatchmakingScoringConfigurationScoringconfigurationid, {
  scoringConfigurationId: /* unknown */
});

Parameters

Name	Type	Required	Description
scoringConfigurationId	unknown	Yes

Response

Type: unknown

---

patchMatchmakingScoringConfigurationScoringconfigurationid

PATCH /v1/matchmaking/scoring-configuration/:scoringConfigurationId

Updates a matchmaking scoring configuration.

Usage

import { fetchApi } from 'rozod';
import { patchMatchmakingScoringConfigurationScoringconfigurationid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(patchMatchmakingScoringConfigurationScoringconfigurationid, {
  scoringConfigurationId: /* unknown */
});

Parameters

Name	Type	Required	Description
scoringConfigurationId	unknown	Yes

Response

Type: unknown

---

postMatchmakingScoringConfigurationScoringconfigurationidSignals

POST /v1/matchmaking/scoring-configuration/:scoringConfigurationId/signals

Creates a matchmaking scoring configuration signal.

Usage

import { fetchApi } from 'rozod';
import { postMatchmakingScoringConfigurationScoringconfigurationidSignals } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(postMatchmakingScoringConfigurationScoringconfigurationidSignals, {
  scoringConfigurationId: /* unknown */
});

Parameters

Name	Type	Required	Description
scoringConfigurationId	unknown	Yes

Response

Type: unknown

---

deleteMatchmakingScoringConfigurationScoringconfigurationidSignalsSignalname

DELETE /v1/matchmaking/scoring-configuration/:scoringConfigurationId/signals/:signalName

Deletes a matchmaking scoring configuration custom signal.

Usage

import { fetchApi } from 'rozod';
import { deleteMatchmakingScoringConfigurationScoringconfigurationidSignalsSignalname } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(deleteMatchmakingScoringConfigurationScoringconfigurationidSignalsSignalname, {
  scoringConfigurationId: /* unknown */,
  signalName: /* unknown */
});

Parameters

Name	Type	Required	Description
scoringConfigurationId	unknown	Yes
signalName	unknown	Yes

Response

Type: unknown

---

patchMatchmakingScoringConfigurationScoringconfigurationidSignalsSignalname

PATCH /v1/matchmaking/scoring-configuration/:scoringConfigurationId/signals/:signalName

Updates a matchmaking scoring configuration signal.

Usage

import { fetchApi } from 'rozod';
import { patchMatchmakingScoringConfigurationScoringconfigurationidSignalsSignalname } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(patchMatchmakingScoringConfigurationScoringconfigurationidSignalsSignalname, {
  scoringConfigurationId: /* unknown */,
  signalName: /* unknown */
});

Parameters

Name	Type	Required	Description
scoringConfigurationId	unknown	Yes
signalName	unknown	Yes

Response

Type: unknown

---

getMatchmakingScoringConfigurationDefaultWeights

GET /v1/matchmaking/scoring-configuration/default-weights

Usage

import { fetchApi } from 'rozod';
import { getMatchmakingScoringConfigurationDefaultWeights } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(getMatchmakingScoringConfigurationDefaultWeights, undefined);

Response

Type: unknown

---

postMatchmakingScoringConfigurationPlace

POST /v1/matchmaking/scoring-configuration/place

Sets a matchmaking scoring configuration for a place.

Usage

import { fetchApi } from 'rozod';
import { postMatchmakingScoringConfigurationPlace } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(postMatchmakingScoringConfigurationPlace, undefined);

Response

Type: unknown

---

deleteMatchmakingScoringConfigurationPlacePlaceid

DELETE /v1/matchmaking/scoring-configuration/place/:placeId

Removes the matchmaking scoring configuration for a place.

Usage

import { fetchApi } from 'rozod';
import { deleteMatchmakingScoringConfigurationPlacePlaceid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(deleteMatchmakingScoringConfigurationPlacePlaceid, {
  placeId: /* unknown */
});

Parameters

Name	Type	Required	Description
placeId	unknown	Yes

Response

Type: unknown

---

getMatchmakingScoringConfigurationsUniverseid

GET /v1/matchmaking/scoring-configurations/:universeId

List all matchmaking scoring configurations for a universe.

Usage

import { fetchApi } from 'rozod';
import { getMatchmakingScoringConfigurationsUniverseid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(getMatchmakingScoringConfigurationsUniverseid, {
  universeId: /* unknown */
});

Parameters

Name	Type	Required	Description
universeId	unknown	Yes

Response

Type: unknown

---

getMatchmakingScoringConfigurationsUniverseidPlaces

GET /v1/matchmaking/scoring-configurations/:universeId/places

List all places with a matchmaking scoring configuration for a universe.

Usage

import { fetchApi } from 'rozod';
import { getMatchmakingScoringConfigurationsUniverseidPlaces } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(getMatchmakingScoringConfigurationsUniverseidPlaces, {
  universeId: /* unknown */
});

Parameters

Name	Type	Required	Description
universeId	unknown	Yes

Response

Type: unknown

---

postMatchmakingServerAttribute

POST /v1/matchmaking/server-attribute

Create a ServerAttributeDefinition.

Usage

import { fetchApi } from 'rozod';
import { postMatchmakingServerAttribute } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(postMatchmakingServerAttribute, undefined);

Response

Type: unknown

---

deleteMatchmakingServerAttributeAttributeid

DELETE /v1/matchmaking/server-attribute/:attributeId

Delete the ServerAttributeDefinition specified by attributeId.

Usage

import { fetchApi } from 'rozod';
import { deleteMatchmakingServerAttributeAttributeid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(deleteMatchmakingServerAttributeAttributeid, {
  attributeId: /* unknown */
});

Parameters

Name	Type	Required	Description
attributeId	unknown	Yes

Response

Type: unknown

---

patchMatchmakingServerAttributeAttributeid

PATCH /v1/matchmaking/server-attribute/:attributeId

Update the ServerAttributeDefinition specified by attributeId.

Usage

import { fetchApi } from 'rozod';
import { patchMatchmakingServerAttributeAttributeid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(patchMatchmakingServerAttributeAttributeid, {
  attributeId: /* unknown */
});

Parameters

Name	Type	Required	Description
attributeId	unknown	Yes

Response

Type: unknown

---

getMatchmakingServerAttributesUniverseid

GET /v1/matchmaking/server-attributes/:universeId

List all ServerAttributeDefinitions of a universe.

Usage

import { fetchApi } from 'rozod';
import { getMatchmakingServerAttributesUniverseid } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(getMatchmakingServerAttributesUniverseid, {
  universeId: /* unknown */
});

Parameters

Name	Type	Required	Description
universeId	unknown	Yes

Response

Type: unknown

---

getMatchmakingUniverseUniverseidFeatureFlags

GET /v1/matchmaking/universe/:universeId/feature-flags

Gets feature flags for a customized matchmaking for a given universe.

Usage

import { fetchApi } from 'rozod';
import { getMatchmakingUniverseUniverseidFeatureFlags } from 'rozod/lib/endpoints/matchmakingv1';

const data = await fetchApi(getMatchmakingUniverseUniverseidFeatureFlags, {
  universeId: /* unknown */
});

Parameters

Name	Type	Required	Description
universeId	unknown	Yes

Response

Type: unknown

---