Multiplayer Server - Upload Secret

Service:

Multiplayer

API Version:

241122

Uploads a multiplayer server game secret.

POST https://titleId.playfabapi.com/MultiplayerServer/UploadSecret

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Required	Type	Description
GameSecret	True	Secret	The game secret to add.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ForceUpdate		boolean	Forces the secret renewal if the secret already exists. Default is false

Responses

Name	Type	Description
200 OK	EmptyResponse
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
EmptyResponse
Secret
UploadSecretRequest	Uploads a multiplayer server game secret.

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

EmptyResponse

Secret

Name	Type	Description
ExpirationDate	string	Optional secret expiration date.
Name	string	A name for the secret. This is used to reference secrets in build configurations.
Value	string	Secret value.

UploadSecretRequest

Uploads a multiplayer server game secret.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ForceUpdate	boolean	Forces the secret renewal if the secret already exists. Default is false
GameSecret	Secret	The game secret to add.

Error Codes

Name	Code
APINotEnabledForGameClientAccess	1082
MultiplayerServerBadRequest	1382
MultiplayerServerConflict	1386
MultiplayerServerForbidden	1384
MultiplayerServerInternalServerError	1387
MultiplayerServerNoContent	1381
MultiplayerServerNotFound	1385
MultiplayerServerTooManyRequests	1380
MultiplayerServerUnauthorized	1383
MultiplayerServerUnavailable	1388