Sandbox images

Create a sandbox image

Changed on

Create a personal-draft sandbox image from a blueprint and respond 201 with its detail. Build it (POST .../build) before a computer can boot from it. Guest callers are denied (a write).

post/projects/{projectId}/images

Request

  • Base URL
    https://app.mcpjam.com/api/v1
  • URL
    https://app.mcpjam.com/api/v1/projects/{projectId}/images
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

Request body

namestring required

Display name for the new sandbox image; must be non-empty after trimming.

blueprintstring required

Blueprint YAML defining the image. Validated server-side; use the validate endpoint for fast feedback.

Response

The sandbox image was created.

idstring required
projectIdstring required
namestring required
contentHashstring required
sharing'user' | 'project' required

user = a personal draft; project = shared with the whole project.

isOwnerboolean required
createdAtnumber required
updatedAtnumber required
blueprintstring required

The image's blueprint YAML (base / initialize / maintenance / knowledge). base must be an allowlisted official image pinned by sha256 digest.

Changes

  • c3f63a334176Revision changes
    • breaking

      added the new required request property

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • info

      added the required property to the response with the status

  • 8e393fd5825fRevision changes
    • warning

      added the new CONFLICT enum value to the response property for the response status

    • warning

      added the new CONFLICT enum value to the response property for the response status

    • warning

      added the new CONFLICT enum value to the response property for the response status

    • warning

      added the new CONFLICT enum value to the response property for the response status

    • warning

      added the new CONFLICT enum value to the response property for the response status

    • warning

      added the new CONFLICT enum value to the response property for the response status

    • warning

      added the new CONFLICT enum value to the response property for the response status