<!--
SYMANTEC: Copyright (c) 2016 Symantec Corporation. All rights reserved.
THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF SYMANTEC CORPORATION. USE,
DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SYMANTEC
CORPORATION.
The Licensed Software and Documentation are deemed to be commercial computer software as defined in
FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19 "Commercial Computer
Software - Restricted Rights" and DFARS 227.7202, Rights in "Commercial Computer Software or Commercial
Computer Software Documentation," as applicable, and any successor regulations, whether delivered by
Symantec as on premises or hosted services. Any use, modification, reproduction release, performance,
display or disclosure of the Licensed Software and Documentation by the U.S. Government shall be solely
in accordance with the terms of this Agreement.
-->
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="web/css/normalize.css"/>
<script>
window.onload = function () {
var toc = "<h4>SEPM APIs</h4>";
toc += "<h5>Production</h5><ul>";
var apiIndex = 1;
//specify how many production APIs SEPM API currently have
var productionApiCount = document.getElementsByName("productionAPI").length;
document.getElementById("content").innerHTML =
document.getElementById("content").innerHTML.replace(
/<h3 id="api"[^>]*>([^<]+)<\/h3>/gi,
function (str, titleText) {
var anchor = titleText.replace(/ /g, "_");
toc += "<li style=\"white-space:nowrap;\"><a href=\"#" + anchor + "\">" + titleText
+ "</a></li>";
if(apiIndex++ == productionApiCount){
toc += "</ul><h5>Experimental</h5><ul>";
}
return "<h3 id='api'><a name=\"" + anchor + "\">"
+ titleText + "</a></h3>";
}
);
toc += "</ul><h4>SEPM Resources</h4><ul>";
document.getElementById("content").innerHTML =
document.getElementById("content").innerHTML.replace(
/<h3 id="resource"><a name="(.+)">(.+)<\/a><\/h3>/gi,
function (str, referText, titleText) {
var anchor = titleText.replace(/ /g, "_");
toc += "<li><a href=\"#" + referText + "\">" + titleText
+ "</a></li>";
return str;
}
);
toc += "</ul>";
document.getElementById("toc").innerHTML += toc;
};
</script>
</head>
<title>API Document</title>
<body class="toc2 toc-left">
<div id="header">
<h1>Symantec Endpoint Protection Manager API Reference</h1>
<div class="details">This page documents the REST APIs that perform Symantec Endpoint Protection Manager operations.</div>
<div id="toc" class="toc2">
<h3>Table of Contents</h3>
</div>
</div>
<div id="content">
<h3>Usage</h3>
<p><b>HTTPS://[SEPM_IP]:8446/sepm/api/v1/<i>command</i></b></p>
<p>Where <i>[SEPM_IP]</i> represents the IP address or hostname of the Symantec Endpoint Protection Manager server, and <i>command</i> represents the API command to use.</p>
<p>For example, for the version command, enter: https://<i>[SEPM_IP]</i>:8446/sepm/api/v1/version</p>
<p><b>Version:</b> v1</p>
<!--[**Terms of Service**]()-->
<h2>APIs</h2>
<h3 id="api" name="productionAPI">/api/v1/cas/key</h3>
<h4>DELETE</h4>
<div id="deleteKey">Deletes an existing CAS API key. </div>
<p><b>Request</b></p>
<p><i>Parameters</i></p>
<p><b>Response</b></p>
<table border="1">
<tr>
<th>Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
<tr>
<td>204</td>
<td>Delete operation success.If the resource did not exist prior to the call, 204 is still returned.</td>
<td> - </td>
</tr>
<tr>
<td>401</td>
<td>The current logged in user does not have sufficient rights to execute the web method or user is unauthorized</td>
<td> - </td>
</tr>
<tr>
<td>500</td>
<td>The web service encountered an error processing the web request</td>
<td> - </td>
</tr>
</table>
<h3 id="api" name="productionAPI">/api/v1/cas/version</h3>
<h4>POST</h4>
<div id="validateCasServer">Validates that Content Analysis Server version is supported by Symantec Endpoint Protection Manager.</div>
<p><b>Request</b></p>
<p><i>Parameters</i></p>
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>body</th>
<td>body</td>
<td>yes</td>
<td>The CAS configurations for checking the version.</td>
<td> - </td>
<td>
<a href="#/definitions/CASServerConfig">CASServerConfig</a>
</td>
</tr>
</table>
<p><b>Response</b></p>
<table border="1">
<tr>
<th>Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
<tr>
<td>200</td>
<td>The web service successfully processed the web request and returned a result.</td>
<td><a href="#/definitions/CASVersionResult">CASVersionResult</a></td>
</tr>
<tr>
<td>400</td>
<td>The parameters are invalid.</td>
<td> - </td>
</tr>
<tr>
<td>401</td>
<td>The user that is currently logged on has insufficient rights to execute the web method, or the user is unauthorized.</td>
<td> - </td>
</tr>
<tr>
<td>404</td>
<td>The requested resource was not found.</td>
<td> - </td>
</tr>
<tr>
<td>500</td>
<td>The web service encountered an error while processing the web request.</td>
<td> - </td>
</tr>
</table>
<h3 id="api" name="productionAPI">/api/v1/ext/groups/syncdelete</h3>
<h4>POST</h4>
<div id="syncDeleteGroups">Delete groups. A system administrator account is required for this REST API.</div>
<p><b>Request</b></p>
<p><i>Parameters</i></p>
<table border="1">
<tr>
<th>Name</th>
<th>Located in</th>
<th>Required</th>
<th>Description</th>
<th>Default</th>
<th>Schema</th>
</tr>
<tr>
<th>domainId</th>
<td>query</td>
<td>no</td>
<td>The id of the domain for which the groups needs to be deleted.</td>
<td> - </td>
<td>string </td>