Multiplayer Server - Upload Certificate

Service:

Multiplayer

API Version:

240426

Uploads a multiplayer server game certificate.

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

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
GameCertificate	True	Certificate	The game certificate to upload.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ForceUpdate		boolean	Forces the certificate renewal if the certificate 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
Certificate
EmptyResponse
UploadCertificateRequest	Uploads a multiplayer server game certificate.

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

Certificate

Name	Type	Description
Base64EncodedValue	string	Base64 encoded string contents of the certificate.
Name	string	A name for the certificate. This is used to reference certificates in build configurations.
Password	string	If required for your PFX certificate, use this field to provide a password that will be used to install the certificate on the container.

EmptyResponse

UploadCertificateRequest

Uploads a multiplayer server game certificate.

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 certificate renewal if the certificate already exists. Default is false
GameCertificate	Certificate	The game certificate to upload.

Error Codes

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