curl --request POST \
--url https://api.instacloud.com/projects/{projectId}/template-deployments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templateCode": "<string>",
"code": "<string>",
"templateVersion": "<string>",
"manifest": "<unknown>",
"branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch": "<string>",
"variables": {},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>"
}
'import requests
url = "https://api.instacloud.com/projects/{projectId}/template-deployments"
payload = {
"templateCode": "<string>",
"code": "<string>",
"templateVersion": "<string>",
"manifest": "<unknown>",
"branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch": "<string>",
"variables": {},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateCode: '<string>',
code: '<string>',
templateVersion: '<string>',
manifest: '<unknown>',
branchId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
branch: '<string>',
variables: {},
deploymentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
region: '<string>'
})
};
fetch('https://api.instacloud.com/projects/{projectId}/template-deployments', 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.instacloud.com/projects/{projectId}/template-deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'templateCode' => '<string>',
'code' => '<string>',
'templateVersion' => '<string>',
'manifest' => '<unknown>',
'branchId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'branch' => '<string>',
'variables' => [
],
'deploymentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'region' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.instacloud.com/projects/{projectId}/template-deployments"
payload := strings.NewReader("{\n \"templateCode\": \"<string>\",\n \"code\": \"<string>\",\n \"templateVersion\": \"<string>\",\n \"manifest\": \"<unknown>\",\n \"branchId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch\": \"<string>\",\n \"variables\": {},\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"region\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.instacloud.com/projects/{projectId}/template-deployments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"templateCode\": \"<string>\",\n \"code\": \"<string>\",\n \"templateVersion\": \"<string>\",\n \"manifest\": \"<unknown>\",\n \"branchId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch\": \"<string>\",\n \"variables\": {},\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"region\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.instacloud.com/projects/{projectId}/template-deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateCode\": \"<string>\",\n \"code\": \"<string>\",\n \"templateVersion\": \"<string>\",\n \"manifest\": \"<unknown>\",\n \"branchId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch\": \"<string>\",\n \"variables\": {},\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"region\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deployment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"step": "create_services",
"templateCode": "<string>",
"templateVersion": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>",
"services": [
{
"name": "<string>",
"serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"state": "pending"
}
],
"error": "<string>",
"logsTail": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"status": "approval_required",
"approvalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "<string>",
"actions": [
"<string>"
],
"message": "<string>",
"url": "<string>",
"nextActions": [
{
"op": "<string>",
"reason": "<string>",
"args": {},
"gated": true
}
]
}{
"error": "<string>",
"missing": [
{
"name": "<string>",
"key": "<string>",
"description": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Create template deployment
curl --request POST \
--url https://api.instacloud.com/projects/{projectId}/template-deployments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"templateCode": "<string>",
"code": "<string>",
"templateVersion": "<string>",
"manifest": "<unknown>",
"branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch": "<string>",
"variables": {},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>"
}
'import requests
url = "https://api.instacloud.com/projects/{projectId}/template-deployments"
payload = {
"templateCode": "<string>",
"code": "<string>",
"templateVersion": "<string>",
"manifest": "<unknown>",
"branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch": "<string>",
"variables": {},
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
templateCode: '<string>',
code: '<string>',
templateVersion: '<string>',
manifest: '<unknown>',
branchId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
branch: '<string>',
variables: {},
deploymentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
region: '<string>'
})
};
fetch('https://api.instacloud.com/projects/{projectId}/template-deployments', 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.instacloud.com/projects/{projectId}/template-deployments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'templateCode' => '<string>',
'code' => '<string>',
'templateVersion' => '<string>',
'manifest' => '<unknown>',
'branchId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'branch' => '<string>',
'variables' => [
],
'deploymentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'region' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.instacloud.com/projects/{projectId}/template-deployments"
payload := strings.NewReader("{\n \"templateCode\": \"<string>\",\n \"code\": \"<string>\",\n \"templateVersion\": \"<string>\",\n \"manifest\": \"<unknown>\",\n \"branchId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch\": \"<string>\",\n \"variables\": {},\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"region\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.instacloud.com/projects/{projectId}/template-deployments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"templateCode\": \"<string>\",\n \"code\": \"<string>\",\n \"templateVersion\": \"<string>\",\n \"manifest\": \"<unknown>\",\n \"branchId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch\": \"<string>\",\n \"variables\": {},\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"region\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.instacloud.com/projects/{projectId}/template-deployments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"templateCode\": \"<string>\",\n \"code\": \"<string>\",\n \"templateVersion\": \"<string>\",\n \"manifest\": \"<unknown>\",\n \"branchId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch\": \"<string>\",\n \"variables\": {},\n \"deploymentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"region\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deploymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deployment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"step": "create_services",
"templateCode": "<string>",
"templateVersion": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"region": "<string>",
"services": [
{
"name": "<string>",
"serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"state": "pending"
}
],
"error": "<string>",
"logsTail": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
},
"status": "approval_required",
"approvalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "<string>",
"actions": [
"<string>"
],
"message": "<string>",
"url": "<string>",
"nextActions": [
{
"op": "<string>",
"reason": "<string>",
"args": {},
"gated": true
}
]
}{
"error": "<string>",
"missing": [
{
"name": "<string>",
"key": "<string>",
"description": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Session access JWT or an API token (insta_<prefix>_<secret>).
Path Parameters
Body
a published registry code (see GET /templates); mutually implied with manifest — one of the two is required
alias of templateCode
optional pin; 404s when the registry serves a different version
inline insta.template.yaml for a local-manifest deploy — the YAML text, or the parsed JSON document
branch NAME (alias of branchId). Omit both for a fresh branch named after the template code
deploy-time variable values (required/optional env vars declared by the manifest)
Show child attributes
Show child attributes
idempotent retry: resume THIS deployment (same services, no duplicates) instead of starting a new one
InstaCloud region slug for EVERY service this deployment creates (see GET /regions). Default: the platform default region. Part of the deployment identity: a retry may omit it or repeat it, a different value is refused with 409.
Response
accepted (deploymentId + deployment to poll) — or approval_required from the governance gate
accepted (deploymentId + deployment to poll) — or approval_required from the governance gate
present when the deployment was accepted
One server-side template deployment run and its progress.
Show child attributes
Show child attributes
approval_required the gated action, or a comma-joined compound set — prefer actions
every capability this approval covers
the console page where a project admin reviews this request
Show child attributes
Show child attributes