Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Image update

Documentation for Image update
Read time 1 minuteLast updated 4 hours ago
Update the game image identified by 
<imageid>
with the details passed through the parameters.
[!TIP] Check out the S3 example URL. 
https://api.multiplay.co.uk/cfp/v1/image/<imageid>/update
METHODCONTENT TYPE
GETapplication/x-www-form-urlencoded

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
accountserviceidThe 
<accountserviceid>
parameter accepts an account service ID (ASID) associated with the specified resource. The credentials in the request header must have access to the ASID to perform the request.		No
imageidThe 
<imageid>
parameter accepts a game image ID representing the game image to update.		No
activeThe 
<active>
parameter accepts a boolean value that controls whether the game image associated with 
<imageid>
is active or not.

If set to 
1
, the game image is activated.

If set to 
0
, the game image is deactivated.		No

Response fields

FieldTypeDescriptionOptional
activeintegerIndicating the state of the image, for example: 1, 0No
created_atstringTime at which the allocation was createdNo
updated_atstringTime at which the allocation was updatedNo
updated_byintegerID of the user that requested image updateNo
latestversionidintegerID of the latest image versionNo
imageidintegerID of the imageNo
pathstringPath to the game filesNo
created_byintegerID of the user that created the imageNo
gameversionidintegerID of the game versionNo

Example request

curl --location -g 'https://api.multiplay.co.uk/cfp/v1/image/<imageid>/update?accountserviceid=<accountserviceid>&active=<active>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "image": {
        "active": <active>,
        "created_at": <created_at>,
        "updated_at": <updated_at>,
        "updated_by": <updated_by>,
        "latestversionid": <latestversionid>,
        "imageid": <imageid>,
        "path": <path>,
        "created_by": <created_by>,
        "gameversionid": <gameversionid>
    }
}