Get template deployment
curl --request GET \
--url https://api.instacloud.com/template-deployments/{deploymentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.instacloud.com/template-deployments/{deploymentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.instacloud.com/template-deployments/{deploymentId}', 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/template-deployments/{deploymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.instacloud.com/template-deployments/{deploymentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.instacloud.com/template-deployments/{deploymentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.instacloud.com/template-deployments/{deploymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}{
"error": "<string>"
}Templates
Get template deployment
Token scope: account · org · project — read-only tokens allowed.
Poll a template deployment: status, current step, per-service URLs, and the failure log tail.
GET
/
template-deployments
/
{deploymentId}
Get template deployment
curl --request GET \
--url https://api.instacloud.com/template-deployments/{deploymentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.instacloud.com/template-deployments/{deploymentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.instacloud.com/template-deployments/{deploymentId}', 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/template-deployments/{deploymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.instacloud.com/template-deployments/{deploymentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.instacloud.com/template-deployments/{deploymentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.instacloud.com/template-deployments/{deploymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}{
"error": "<string>"
}Authorizations
Session access JWT or an API token (insta_<prefix>_<secret>).
Path Parameters
Response
Default Response
One server-side template deployment run and its progress.
partial = some services came up healthy, others failed — created resources are kept either way
Available options:
running, succeeded, failed, partial the pipeline step the run is currently on (or stopped at)
Available options:
create_services, write_variables, deploy, health_check InstaCloud region slug every service of this deployment was created in. Deployments recorded before regions were recorded read as the platform default.
Show child attributes
Show child attributes
container log tail captured when a service never became healthy