Image update create
Warning: The API documentation here is for Clanforge. If you’re using Multiplay Hosting, refer to the Multiplay Hosting API documentation.
Create a job to update the game image identified by <imageid>.
https://api.multiplay.co.uk/cfp/v1/imageupdate/createMETHOD |
| GET |
Request parameters
| VARIABLE | DESCRIPTION | OPTIONAL |
| imageid | The <imageid> parameter accepts a game image ID. | No |
| desc | The <desc> parameter accepts a string containing a description of the image update. | No |
| machineid | The <machineid> parameter accepts a machine ID. The provided machine ID is used to perform the image update on. | No |
| 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 |
| url | The <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 For more information, refer to the [documentation](../topics/image-update-create-url-parameters.md) |
Response fields
| Field | Type | Description | Optional |
|---|---|---|---|
| updateid | integer | ID of the update | Yes |
| 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/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>
}