Multiplayer Server - Get Container Registry Credentials

Service:

Multiplayer

API Version:

240401

Gets the credentials to the container registry.

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

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	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	GetContainerRegistryCredentialsResponse
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
GetContainerRegistryCredentialsRequest	Gets credentials to the container registry where game developers can upload custom container images to before creating a new build.
GetContainerRegistryCredentialsResponse

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

GetContainerRegistryCredentialsRequest

Gets credentials to the container registry where game developers can upload custom container images to before creating a new build.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

GetContainerRegistryCredentialsResponse

Name	Type	Description
DnsName	string	The url of the container registry.
Password	string	The password for accessing the container registry.
Username	string	The username for accessing the container registry.

Error Codes

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