Queue an image install

Last updated: May 29, 2026

Queue an image install

Queue the image install identified by `jobid`. The response shape depends on whether the job is a mirror job or a machine job: - Mirror jobs return a `versionmirrorid` field. - Machine jobs return `machinejobid` and `installs_squashed` fields. **WARNING:** This endpoint uses HTTP GET but performs a state-changing operation. Do not cache or automatically retry this request.

Endpoint

GET /cfp/v1/imageinstall/{jobid}/queue

Path Parameters

Name

Type

Required

Description

jobid

integer

Yes

Image install job ID. The identified install job will be queued.

Query Parameters

Name

Type

Required

Description

mirroring

boolean

Yes

Whether the install job is mirrored. Set true if mirrored, false if not. You can determine this by calling the Image Install Status endpoint.

Example Request

curl -X GET "https://api.multiplay.dev/cfp/v1/imageinstall/:jobid/queue?mirroring=<mirroring>" \
  -H "Authorization: Bearer <token>"

Responses

Status

Description

200

Image install queued successfully.

400

401

403

404

500