Create an image version
Last updated: May 29, 2026
Create an image version
Create a new image version for the image identified by the specified image difference `diffid`. If the image difference analysis has no changes, it will create a full image instead of a partial image. **WARNING:** This endpoint uses HTTP GET but performs a state-changing operation. Do not cache or automatically retry this request.
Endpoint
GET /cfp/v1/imageversion/createQuery Parameters
Name | Type | Required | Description |
|---|---|---|---|
| integer | Yes | ID of a completed image difference analysis. |
| integer | Yes | If 1, stops all affected game servers during installation and restarts them after. If 0, game servers restart after exit or profile change. |
| integer | No | If 1, creates a full image install instead of partial. Must be 1 if the diffid includes no differences. |
| string | No | String value identifying the game's internal build. On success, the Multiplay Game Version version field is set to this value. |
| integer | No | If 1, forces image version creation even with active allocations. Default behavior fails if active allocations exist. |
| integer | No | Unix timestamp for when the job should start. |
| integer | No | Used with disable_percentage. Minutes before failing machines earlier than the default 4-hour timeout. |
| number | No | Used with disable_timeout. Once install success reaches this percentage, machines not reporting success after disable_timeout minutes are disabled. |
Example Request
curl -X GET "https://api.multiplay.dev/cfp/v1/imageversion/create?diffid=<diffid>&restart=<restart>&full=<full>&game_build=<game_build>&force=<force>&install_at=<install_at>&disable_timeout=<disable_timeout>&disable_percentage=<disable_percentage>" \
-H "Authorization: Bearer <token>"Responses
Status | Description |
|---|---|
| Image version creation initiated successfully. |
| |
| |
| |
|