Sandbox images

Share a sandbox image with the project

Promote a personal-draft sandbox image to a project-shared one. Requires project admin. Bodyless. Guest callers are denied (a write).

post/projects/{projectId}/images/{imageId}/promote

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

imageIdstring required

Sandbox image ID, as returned by the project's image list.

Request body

object required

Response

The now-shared sandbox image.

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

Changed in 3 of the 77 revisions of this API.172

  • c3f63a33417611See the full diff
    • removed the required property dockerfile from the response with the 200 status

      response-required-property-removed

    • added the required property blueprint to the response with the 200 status

      response-required-property-added

    • added the new CONFLICT enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new CONFLICT enum value to the code response property for the response status 401

      response-property-enum-value-added

    • added the new CONFLICT enum value to the code response property for the response status 403

      response-property-enum-value-added

    • added the new CONFLICT enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new CONFLICT enum value to the code response property for the response status 429

      response-property-enum-value-added

    • added the new CONFLICT enum value to the code response property for the response status 500

      response-property-enum-value-added

    • added the new CONFLICT enum value to the code response property for the response status 502

      response-property-enum-value-added

    • endpoint added

      endpoint-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog