Templates

Rebuild an existing template

Queues a new build for this template. Used to retry after a failed build, or to rebuild when the base image has been updated.

The first build is queued automatically when the template is created via POST /templates — this endpoint is only for subsequent builds.

Idempotency

If an in-flight build (pending/building/snapshotting) already exists for this template with the same build spec, this endpoint returns the existing build’s id with 200 instead of creating a duplicate.

POST

templates

{template_id}

builds

Rebuild an existing template

curl --request POST \
  --url https://api.superserve.ai/templates/{template_id}/builds \
  --header 'X-API-Key: <api-key>'

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.superserve.ai/templates/{template_id}/builds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superserve.ai/templates/{template_id}/builds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.superserve.ai/templates/{template_id}/builds"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.superserve.ai/templates/{template_id}/builds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "build_spec_hash": "<string>",
  "error_message": "step_failed: step 1/2 failed after 3s: exited with code 100",
  "started_at": "2023-11-07T05:31:56Z",
  "finalized_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "build_spec_hash": "<string>",
  "error_message": "step_failed: step 1/2 failed after 3s: exited with code 100",
  "started_at": "2023-11-07T05:31:56Z",
  "finalized_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

template_id

string<uuid>

required

The unique identifier of the template.

Response

Existing in-flight build returned (idempotent)

string<uuid>

template_id

string<uuid>

status

enum<string>

Available options:

pending,

building,

snapshotting,

ready,

failed,

cancelled

build_spec_hash

string

Stable hash of the build_spec at submission time. Used for idempotent submits.

error_message

string

Populated when status = failed. The message is prefixed with a stable error code the UI / SDK can key on: image_pull_failed, step_failed, boot_failed, snapshot_failed, start_cmd_failed, ready_cmd_failed, or build_failed (fallback).

Example:

"step_failed: step 1/2 failed after 3s: exited with code 100"

started_at

string<date-time>

finalized_at

string<date-time>

created_at

string<date-time>

Rebuild an existing template

curl --request POST \
  --url https://api.superserve.ai/templates/{template_id}/builds \
  --header 'X-API-Key: <api-key>'

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.superserve.ai/templates/{template_id}/builds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superserve.ai/templates/{template_id}/builds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.superserve.ai/templates/{template_id}/builds"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.superserve.ai/templates/{template_id}/builds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "build_spec_hash": "<string>",
  "error_message": "step_failed: step 1/2 failed after 3s: exited with code 100",
  "started_at": "2023-11-07T05:31:56Z",
  "finalized_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "build_spec_hash": "<string>",
  "error_message": "step_failed: step 1/2 failed after 3s: exited with code 100",
  "started_at": "2023-11-07T05:31:56Z",
  "finalized_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Sandboxes

Exec

Files

Templates

Secrets

Billing

Team Management

Activity

Rebuild an existing template

Idempotency

Authorizations

Path Parameters

Response