Image update status
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 the status of the image update identified by <updateid>.
https://api.multiplay.co.uk/cfp/v1/imageupdate/<updateid>/statusMETHOD |
| 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 |
| updateid | The <updateid> parameter accepts an update ID representing the image update job to get the status of.The image update ID is returned from the Image Update Create endpoint. | No |
Response fields
| Field | Type | Description | Optional |
|---|---|---|---|
| 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 |
Example request
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/imageupdate/<updateid>/status?accountserviceid=<accountserviceid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'Example response
{
"jobprogress": <jobprogress>,
"jobstateid": <jobstateid>,
"jobstart": <jobstart>,
"joberror": null,
"jobeta": <jobbeta>,
"jobfailed": <jobfailed>,
"success": true,
"jobcreated": <jobcreated>,
"updateid": <updateid>,
"jobupdated": <jobupdateid>,
"jobstatename": <jobstatename>
}