Game version list

Warning: The API documentation here is for Managed Game Server Hosting (Clanforge). If you’re using Game Server Hosting (Multiplay), refer to the Game Server API documentation.

Get a list of game versions for the specified <accountserviceid>.

https://api.multiplay.co.uk/cfp/v1/gameversion/list

METHOD

GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
accountserviceidAccount service ID associated with the specified resource.No
gameidGame ID to list the associated game versions.Yes
gameversionidOptional game version filter.Yes
gameversion_identifierOptional game version identifier filter.Yes

Response fields

FieldTypeDescriptionOptional
gameversionsarrayList of game version objects.No

Game version object

FieldTypeDescriptionOptional
identifierstringUnique identifier of the game version.No
descriptionstringDescription of the game version.Yes
gameidintegerGame ID which is related to this game version.No
versionstringVersion information about the game version. Can be an empty string if not set.No
gameversionidintegerID of the game version.No

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/gameversion/list?accountserviceid=<accountserviceid>&gameid=<gameid>&gameversionid=<gameversionid>&gameversion_identifier=<gameversion_identifier>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "gameversions": [
        {
            "identifier": <identifier>,
            "description": <description>,
            "gameid": <gameid>,
            "version": <version>,
            "name": "<name",
            "gameversionid": <gameversionid>
        },
        ...
    ]
}