Create an image update job
Last updated: May 29, 2026
Create an image update job
Create a job to update the game image identified by `imageid`. The update source can be an AWS S3 bucket, SteamCMD or Google Cloud Storage. - `s3://:@//?` - `steam://:@install//` - `gs:///?credentials=` When using the API (not the web panel), credentials in the URL must be double-encoded. **WARNING:** This endpoint uses HTTP GET but performs a state-changing operation. Do not cache or automatically retry this request.
Endpoint
GET /cfp/v1/imageupdate/createQuery Parameters
Name | Type | Required | Description |
|---|---|---|---|
| integer | Yes | Game image ID. |
| string | Yes | Description of the image update. |
| integer | Yes | Machine ID to perform the image update on. |
| string | No | URL from which to acquire the update. Supports s3://, steam://, gs://, and cos:// schemes. Optional if the image has a default update_url; required if it does not. If a requesttimeout URL parameter is specified, it overrides the default 2-minute timeout. |
Example Request
curl -X GET "https://api.multiplay.dev/cfp/v1/imageupdate/create?imageid=<imageid>&desc=<desc>&machineid=<machineid>&url=<url>" \
-H "Authorization: Bearer <token>"Responses
Status | Description |
|---|---|
| Image update job created successfully. |
| |
| |
| |
|