Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Image update create

Documentation for Image update create
Read time 1 minuteLast updated 2 months ago
Create a job to update the game image identified by 
<imageid>
. 
https://api.multiplay.co.uk/cfp/v1/imageupdate/create
METHOD
GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
imageidThe 
<imageid>
 parameter accepts a game image ID.		No
descThe 
<desc>
 parameter accepts a string containing a description of the image update.		No
machineidThe 
<machineid>
 parameter accepts a machine ID. The provided machine ID is used to perform the image update on.		No
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
urlThe 
<url>
 parameter accepts a URL from which to acquire the update. For example, an AWS S3 bucket URL that has the updated game image.		If the image has a default update URL (
<update\_url>
), this parameter is optional.

If the image doesn't have a default update URL, this parameter isn't optional.

If the 
<requesttimeout>
 URL parameter is specified, then this will override the default of 2m.

For more information, refer to the documentation

Response fields

Field

Type

Description

Optional

updateidintegerID of the updateYes
jobcreatedintegerUnix timestamp of when the job was createdNo
joberrorstringMessage indicating the job errorYes
jobetaintegerUnix timestamp representing the time at which the job is expected to completeYes
jobfailedintegerNumeric flag indicating whether the job has failedNo
jobprogressintegerPercentage between 0 and 100 indicating job progressNo
jobstartstringUnix timestamp of when the job was startedYes
jobstateidintegerJob state ID indicating the state of the jobYes
jobstatenamestringName of the job stateNo
jobupdatedintegerUnix timestamp of when the job was last updatedNo
successbooleanFlag indicating whether this request was a successNo

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/imageupdate/create?<imageid>=&desc=%22exampleDescription%22&machineid=<machineid>&accountserviceid=<accountserviceid>&url=<url>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "updateid": <updateid>,
    "jobcreated": <jobcreated>,
    "joberror": <joberror>,
    "jobeta": <jobeta>,
    "jobfailed": <jobfailed>,
    "jobprogress": <jobprogress>,
    "jobstart": <jobstart>,
    "jobstateid": <jobstateid>,
    "jobstatename": <jobstatename>,
    "jobupdated": <jobupdated>
}