Save an existing configuration as a reusable template Saves the specified configuration as a template for future reuse across deployments.
Request URL https://{server-hostname}:8383/dcapi/configuration/{collectionId}/saveAsTemplate
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers - Path Parameters collectionId string Mandatory
The unique numeric identifier of the configuration to be saved as a reusable template. Fetch from Get Configurations View .
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
--url https://appdomain/dcapi/configuration/{collectionId}/saveAsTemplate \
--header 'Accept: application/collnTemplateDetails.v1+json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://appdomain/dcapi/configuration/{collectionId}/saveAsTemplate"))
.header("Accept", "application/collnTemplateDetails.v1+json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
headers = {
'Accept': "application/collnTemplateDetails.v1+json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("POST", "/dcapi/configuration/{collectionId}/saveAsTemplate", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/collnTemplateDetails.v1+json");
response = invokeUrl
[
url: "https://appDomain/dcapi/configuration/{collectionId}/saveAsTemplate"
type: POST
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/collnTemplateDetails.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/configuration/{collectionId}/saveAsTemplate' -Method POST -Headers $headers▼ Show full
Response Parameters - HTTP code 200 Response Body - application/json JSON object
Hide Sub-Attributes templateId long
The unique ID of the newly created template
status string
Human-readable confirmation message
- HTTP code 400 Response Body - application/json JSON object
Hide Sub-Attributes error_code string
SERVICE_NOT_AVAILABLE: the configuration was created from a Global Template and save-as-template is restricted for MSP
error_description string
Message indicating Global Template restriction prevents save-as-template
- HTTP code 401 Response Body - application/json JSON object
Hide Sub-Attributes errorCode long
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
errorMsg string
Authentication failure reason
- HTTP code 413 Response Body - application/json JSON object
Hide Sub-Attributes error_code string
INTERNAL_SERVER_ERROR: storage limit exceeded on the server to create the template
error_description string
Message indicating insufficient storage space to create the template
Possible Response Codes Sample Response: HTTP 200 Template created successfully from existing configuration
Copied!
{
"templateId": 2001,
"status": "Template created successfully."
}
▼ Show full
Sample Response: HTTP 400 Configuration was created from a Global Template
Copied!
{
"error_description": "Configuration created from a Global Template cannot be saved as template",
"error_code": "SERVICE_NOT_AVAILABLE"
}
▼ Show full
Sample Response: HTTP 401 {
"error_description": "Access denied - You are not allowed to access the requested resource.",
"error_code": "UAC_UNAUTHORIZED"
}
▼ Show full
Sample Response: HTTP 413 Server storage limit exceeded
Copied!
{
"error_description": "Insufficient storage space to create the template",
"error_code": "INTERNAL_SERVER_ERROR"
}
▼ Show full
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold. Threshold - Number of API calls allowed within the specified duration. Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.