Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Image install queue

Documentation for Image install queue
Read time 1 minuteLast updated 8 hours ago
Queue the image install identified by 
<jobid>
. 
https://api.multiplay.co.uk/cfp/v1/imageinstall/<jobid>/queue
METHOD
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
jobid
The 
<jobid>
 parameter accepts an image install job ID. The identified image install job will be queued.
No
mirroring
The 
<mirroring>
 parameter accepts a boolean value indicating whether the install job is mirrored.

Set this value to 
true
 if the image install 
<jobid>
 is mirrored.

Set this value to 
false
 if the image install 
<jobid>
 isn't mirrored.

You can determine if an install job is mirrored by calling the Image Install Status endpoint.
No

Response fields

Field

Type

Description

Optional

versionmirrorid
integer
ID of the version mirror id
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/imageinstall/<jobid>/queue?accountserviceid=<accountserviceid>&mirroring=<mirroring>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response for mirror jobs

{
    "versionmirrorid": <versionmirrorid>,
    "jobcreated": <jobcreated>,
    "joberror": <joberror>,
    "jobeta": <jobeta>,
    "jobfailed": <jobfailed>,
    "jobprogress": <jobprogress>,
    "jobstart": <jobstart>,
    "jobstateid": <jobstateid>,
    "jobstatename": <jobstatename>,
    "jobupdated": <jobupdated>
}

Example response for machine jobs

{
    "machinejobid": <machinejobid>,
    "installs_squashed": <installs_squashed>,
    "jobcreated": <jobcreated>,
    "joberror": <joberror>,
    "jobeta": <jobeta>,
    "jobfailed": <jobfailed>,
    "jobprogress": <jobprogress>,
    "jobstart": <jobstart>,
    "jobstateid": <jobstateid>,
    "jobstatename": <jobstatename>,
    "jobupdated": <jobupdated>
}