Install a template from the public template library

Adds a template of the public template library to this network as your own template (shared with you as its owner), exactly as importing its XML in the console would.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do

Adds a template of the public template library to this network as your own template (shared with you as its owner), exactly as importing its XML in the console would. A template the network already has is not installed twice: the answer names it instead. With update=true a newer library build replaces an installed template in place - every banner using it changes with it. Requires the Templates create permission and the Templates view permission on all templates (the library reports what the whole network holds). An update also needs update permission on the installed template.

Form Params

entryId string required

The library template's id, as the library list gives it

catfish/catfish/mobile-catfish

update boolean

Replace an installed template with the library's newer build. Every banner using the template changes with it.

false

Responses

200

Installed: success true, templateId, its properties

400

Not installed because the network already has it (or no newer build): success false, status, installedTemplateId, message

401

Authentication error

403

No Templates create permission, Templates view is not granted on all templates, or (update) no update permission on the installed template

404

No such template in the library

503

The template library is not set up on this network or could not be read

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'entryId=catfish/catfish/mobile-catfish' \
  --data-urlencode 'update=false'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"entryId": "catfish/catfish/mobile-catfish", "update": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"entryId":"catfish/catfish/mobile-catfish","update":"false"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("entryId=catfish%2Fcatfish%2Fmobile-catfish&update=false"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["entryId"] = "catfish/catfish/mobile-catfish", ["update"] = "false" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do", strings.NewReader(`entryId=catfish%2Fcatfish%2Fmobile-catfish&update=false`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'entryId=catfish%2Fcatfish%2Fmobile-catfish&update=false');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/install.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('entryId' => "catfish/catfish/mobile-catfish", 'update' => "false")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body