Multiplayer Server - List Container Image Tags

Service:

Multiplayer

API Version:

240412

Lists the tags for a custom container image.

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

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.).
ImageName	string	The container images we want to list tags for.
PageSize	number	The page size for the request.
SkipToken	string	The skip token for the paged request.

Responses

Name	Type	Description
200 OK	ListContainerImageTagsResponse
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
ListContainerImageTagsRequest	Returns a list of the tags for a particular container image that exists in the container registry for a title.
ListContainerImageTagsResponse

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

ListContainerImageTagsRequest

Returns a list of the tags for a particular container image that exists in the container registry for a title.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ImageName	string	The container images we want to list tags for.
PageSize	number	The page size for the request.
SkipToken	string	The skip token for the paged request.

ListContainerImageTagsResponse

Name	Type	Description
PageSize	number	The page size on the response.
SkipToken	string	The skip token for the paged response.
Tags	string[]	The list of tags for a particular container image.

Error Codes

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