Multiplayer Server - Untag Container Image
Untags a container image.
POST https://titleId.playfabapi.com/MultiplayerServer/UntagContainerImage
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 image which tag we want to remove. |
Tag |
string |
The tag we want to remove. |
Responses
Name | Type | Description |
---|---|---|
200 OK | ||
400 Bad Request |
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 |
---|---|
Api |
The basic wrapper around every failed API response |
Empty |
|
Untag |
Removes the specified tag from the image. After this operation, a 'docker pull' will fail for the specified image and tag combination. Morever, ListContainerImageTags will not return the specified tag. |
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
UntagContainerImageRequest
Removes the specified tag from the image. After this operation, a 'docker pull' will fail for the specified image and tag combination. Morever, ListContainerImageTags will not return the specified tag.
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 image which tag we want to remove. |
Tag |
string |
The tag we want to remove. |
Error Codes
Name | Code |
---|---|
APINotEnabledForGameClientAccess | 1082 |
MultiplayerServerBadRequest | 1382 |
MultiplayerServerForbidden | 1384 |
MultiplayerServerInternalServerError | 1387 |
MultiplayerServerNotFound | 1385 |
MultiplayerServerTooManyRequests | 1380 |
MultiplayerServerUnauthorized | 1383 |
MultiplayerServerUnavailable | 1388 |