Skip to main content
POST
Create and start a rebuild

Authorizations

Authorization
string
header
required

API Key or Access Token, always sent as Authorization: Bearer <token>. The gateway recognizes the token type automatically.

Path Parameters

template_id
string<uuid>
required

Owning GMI Template identifier.

Query Parameters

idc_name
string

Filter by data center name, e.g. us-denver-1

Body

application/json
source
object
required

Manual Build source. Sandbox sources use the snapshot endpoint.

commands
string[]

Shell command strings executed sequentially during the Build.

Maximum array length: 100
Required string length: 1 - 8192
envs
object

Environment variables available only during the Template Build. They are visible to subsequent build commands/steps and are not persisted into the resulting template artifact as sandbox runtime environment variables. Pass runtime env when creating a Sandbox instead. Write-only: values are never returned on Template or TemplateBuild responses. Keys must be unique (JSON object); the server orders them deterministically by key. Key names must match [A-Za-z_][A-Za-z0-9_]*.

start_cmd
string

Launch command persisted with the Build and applied when Sandboxes created from this Template start.

Required string length: 1 - 8192

Response

The Build record is created and immediately addressable via GET /templates/{template_id}/builds/{id}; build progress is reported by status, not by the status code.

request_id
string
required

HTTP request correlation identifier.

data
object
required