Image diff create
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.
Trigger an image difference analysis job, which will report the differences between the latest version of the game image identified by <imageid> and the current state on <machineid>.
https://api.multiplay.co.uk/cfp/v1/imagediff/createMETHOD |
| GET |
Request Parameters
| VARIABLE | DESCRIPTION | OPTIONAL |
| accountserviceid | The <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 |
| imageid | The <imageid> parameter accepts a game image ID of the game image to update. | No |
| machineid | The <machineid> parameter accepts a machine ID of the machine on which to perform the difference analysis. | No |
| diffid | The <diffid> parameter accepts a difference analysis ID.If a The provided ID must identify a difference analysis that's either complete or failed. | Yes |
Response Fields
| Field | Type | Description | Optional |
|---|---|---|---|
| diffid | integer | ID of the diff being used | No |
| jobcreated | integer | Unix timestamp of when the job was created | No |
| joberror | string | Message indicating the job error | Yes |
| jobeta | integer | Unix timestamp representing the time at which the job is expected to complete | Yes |
| jobfailed | integer | Numeric flag indicating whether the job has failed | No |
| jobprogress | integer | Percentage between 0 and 100 indicating job progress | No |
| jobstart | string | Unix timestamp of when the job was started | Yes |
| jobstateid | integer | Job state ID indicating the state of the job | Yes |
| jobstatename | string | Name of the job state | No |
| jobupdated | integer | Unix timestamp of when the job was last updated | No |
| success | boolean | Flag indicating whether this request was a success | No |
Possible job states (values of jobstateid):
JOBSTATEID | DESCRIPTION |
1 | Created (new job) |
2 | Pending (waiting to be queued) |
3 | Queued (waiting to be processed) |
4 | Running |
5 | Completed |
6 | Failed |
Example Request
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/imagediff/create?accountserviceid=<accountserviceid>&imageid=<imageid>&machineid=<machineid>&diffid=<diffid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'Example response
{
"diffid" : <diffid>,
"jobcreated" : <jobcreated>,
"joberror" : <joberror>,
"jobeta" : <jobeta>,
"jobfailed" : <jobfailed>,
"jobprogress" : <jobprogress>,
"jobstart" : <jobstart>,
"jobstateid" : <jobstateid>,
"jobstatename" : <jobstatename>,
"jobupdated" : <jobupdated>
}