Image options
Documentation for Image options
Read time 1 minuteLast updated 2 months ago
Get all available image options for the specified game image version.
https://api.multiplay.co.uk/cfp/v1/image/options
Request parameters
| METHOD |
| GET |
| VARIABLE | DESCRIPTION | OPTIONAL |
| accountserviceid | The | No |
| gameid | The This parameter is required if you specify the | Yes 1 |
| imageid | The If you specify this parameter, you must also include the | Yes 1 |
| gameversion_identifier | The If you specify this parameter, you must also specify the | Yes |
<imageid><gameid>Response fields
Field | Type | Description | Optional |
|---|---|---|---|
| diffid | integer | ID of the diff which the provided image ID is locked by | Yes |
| updateid | integer | ID of the update which the provided image ID is locked by | Yes |
| update_url | string | Information about the update of an image | Yes |
| games | array | List of game objects available | No |
| images | array | List of image objects relating to a provided Game ID | No |
| machines | array | List of machine objects usable as build box | Yes |
Game object
Field | Type | Description | Optional |
|---|---|---|---|
| gameid | integer | ID of the game | No |
| name | string | Name of the game | No |
Image object
Field | Type | Description | Optional |
|---|---|---|---|
| imageid | integer | ID of the image | No |
| name | string | Name of the image | No |
| gameversionid | string | ID of the game version that this image uses | No |
Machine object
Field | Type | Description | Optional |
|---|---|---|---|
| machineid | integer | ID of the machine | No |
| name | string | Name of the machine | No |
Example request
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/image/options?accountserviceid=<accountserviceid>&gameid=<gameid>&imageid=<imageid>&gameversion_identifier=<GameVersionIdentifier>' \ --header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'
Example response
{ "diffid": <diffid>, "updateid": <updateid>, "update_url": <updateurl>, "games" : [ { "gameid" : <gameid>, "name" : <game_name> }, ... ], "images" : [ { "imageid" : <imageid>, "name" : <image_name>, "gameversionid" : <gameversionid> }, ... ], "machines" : [ { "machineid" : <machineid>, "name" : <machine_name> }, ... ] }