Tag Verification

the tag verification endpoint allows you to check if a specific version (tag) of your game image is available in a particular region of the gameye fleet this is useful when you need to ensure that a specific version of your game server is ready to be deployed checking tag availability endpoint get /tag/{region}/{image}/{version} path parameters parameter type required description region string yes the region name to check (e g , "eu west 1", "eu central 1") image string yes the id of your game image version string yes the image version (docker tag) you want to check example request get /tag/eu central 1/my game server/v1 2 3 http/1 1 host api gameye io authorization bearer your token here success response on success, you'll receive a 200 ok response with a simple json object indicating whether the tag exists { "exists" true } if the tag doesn't exist, the response will be { "exists" false } error responses status code description 400 bad request invalid request format 401 unauthorized invalid bearer token 404 not found image not found or you're not authorized to use it error response example { "statuscode" 404, "code" "resource not found", "message" "image not found or you are not authorized to use this image ", "details" "please verify the image name and tag are correct ", "identifier" "3bc545b7 4750 47e6 a918 c93debc58663", "path" "/tag/eu central 1/my game server/1 0 0", "timestamp" "2023 04 01t12 00 00z" } use cases version validation before creating a session with a specific version, you can verify that the version is available in your target region call the tag verification endpoint if exists is true , proceed with creating the session if exists is false , fall back to another version or notify administrators rolling updates when rolling out a new version of your game server deploy the new version to your container registry use the tag verification endpoint to monitor when the new version becomes available across regions begin creating new sessions with the new version once it's available availability monitoring for operations monitoring regularly check critical versions of your game server alert operations staff if a required version becomes unavailable best practices version strategy use a clear versioning strategy for your game server images (e g , semantic versioning) pre flight checks before creating a session with a specific version, verify its availability fallback mechanisms have a fallback strategy if your preferred version is unavailable multiple regions remember that image availability can vary by region example version rollout process 1\ build new game server version v1 2 3 2\ push to container registry 3\ wait for distribution (may take some time) 4\ check availability in each region get /tag/eu west 1/my game server/v1 2 3 get /tag/eu central 1/my game server/v1 2 3 get /tag/us east 1/my game server/v1 2 3 5\ when available in all regions, update session creation process to use the new version