Artifacts

the artifacts endpoint allows you to download files from game session containers after they've been terminated this is useful for retrieving logs, save files, or any other data generated during the session downloading artifacts endpoint get /artifacts query parameters parameter type required description session string yes the id of the session to download artifacts from path string yes the absolute path inside the container to the file or folder you want to download example request get /artifacts?session=c595bc6f 8522 4a62 95cd 8742136643ea\&path=/home/gameserver/logs/server log http/1 1 host api gameye io authorization bearer your token here response when successful, the response will be a 200 ok with the artifact file in tar gz format the content type will be application/x tar error responses status code description 401 unauthorized invalid bearer token 404 not found session doesn't exist or has been removed from the host machine error response example { "statuscode" 404, "code" "resource not found", "message" "could not find a session with the given session id ", "details" "it is possible that either the session has never existed at all or the container's lifespan on the machine has expired ", "identifier" "3bc545b7 4750 47e6 a918 c93debc58663", "path" "/artifacts", "timestamp" "2023 04 01t12 00 00z" } 🔍 tip always include the identifier when contacting support about errors this helps us quickly trace the exact issue in our systems important notes here are some key things to know about downloading artifacts session must be stopped artifacts are only available after a session has been terminated size limit please limit your download size to a maximum of 100mb limited availability artifacts are only available until the container is removed from its host machine this means your logs may not be available indefinitely after termination path format use absolute unix paths (starting with / ) when specifying the path to the artifact downloading folders you can specify a folder path to download all of its contents common use cases downloading game server logs for debugging purposes retrieving player statistics or match results collecting crash dumps for analysis backing up save files or game state best practices download important artifacts as soon as possible after stopping a session use specific paths to download only what you need consider implementing automatic artifact collection in your workflow parse and process the downloaded data to extract useful information example applications downloading server logs get /artifacts?session=c595bc6f 8522 4a62 95cd 8742136643ea\&path=/home/gameserver/logs http/1 1 retrieving a specific match report get /artifacts?session=c595bc6f 8522 4a62 95cd 8742136643ea\&path=/home/gameserver/matches/match 123 json http/1 1 getting a crash dump get /artifacts?session=c595bc6f 8522 4a62 95cd 8742136643ea\&path=/home/gameserver/crashdump log http/1 1