Agents
This API provides endpoints for IDP agents.
Download Agents OpenAPI Document
End Points
Get IDP Agents Information
Regenerate Installation Key for IDP Agent
Download IDP Agent for a Specific Type
Download IDP Device Agent for a Specific Platform
Attribute
type
string
Type of the agent.
display_name
string
Display name of the agent.
endpoint_name
string
Name of the endpoint for the agent.
platforms
array
name
string
Name of the platform.
download_url
uri
URL to download the agent for the platform.
version
string
Version of the agent for the platform.
installation_details
object
status
string
Status of the agent installation.
Allowed Values:
- installed
- not_installed
installed_count
integer
Number of devices where the agent is installed.
total_devices_count
integer
Total number of devices available for installation.
download_url
uri
URL to download the agent.
version
string
Version of the agent.
installation_key
string
Installation key for the agent.
installation_details
object
status
string
Status of the agent installation.yifusdvoyhvois
Allowed Values:
- installed
- not_installed
{
"type": "DeviceAgent",
"display_name": "IDProtection Agent",
"endpoint_name": "ComputerDevices",
"platforms": [
{
"name": "windows",
"download_url": "https://idprotection.manageengine.com/static_downloads/idsecurityagent/2.0.0/IDProtectionAgent.msi",
"version": "2.0.0",
"installation_details": {
"status": "installed",
"installed_count": 100,
"total_devices_count": 1000
}
}
],
"download_url": "https://idprotection.manageengine.com/static_downloads/idsecurityagent/2.0.0/IDProtectionAgent.msi",
"version": "2.0.0",
"installation_key": "1234567890abcdef",
"installation_details": {
"status": "installed"
}
}
Get IDP Agents Information
Retrieves information about IDP agents.
OAuth Scope : id360.conditional_access_policy.read,id360.conditional_access_policy.all
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/agents-info"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/protection/agents-info")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Accept: 'application/json',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://id360.manageengine.com/api/v1/protection/agents-info', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("id360.manageengine.com")
headers = {
'Accept': "application/json",
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
conn.request("GET", "/api/v1/protection/agents-info", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/protection/agents-info",
"headers": {
"Accept": "application/json",
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url https://id360.manageengine.com/api/v1/protection/agents-info \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"data": [
{
"type": "DeviceAgent",
"display_name": "IDProtection Agent",
"endpoint_name": "ComputerDevices",
"installation_key": "1234567890abcdef",
"platforms": [
{
"name": "windows",
"download_url": "https://idprotection.manageengine.com/static_downloads/idsecurityagent/2.0.0/IDProtectionAgent.msi",
"version": "2.0.0",
"installation_details": {
"status": "installed",
"installed_count": 100,
"total_devices_count": 1000
}
},
{
"name": "macos",
"download_url": "https://idprotection.manageengine.com/static_downloads/idsecurityagent/2.0.0/IDProtectionAgent.dmg",
"version": "2.0.0",
"installation_key": "1234567890abcdef",
"installation_details": {
"status": "installed",
"installed_count": 100,
"total_devices_count": 1000
}
},
{
"name": "linux",
"download_url": "https://idprotection.manageengine.com/static_downloads/idsecurityagent/2.0.0/IDProtectionAgent.tar.gz",
"version": "2.0.0",
"installation_key": "1234567890abcdef",
"installation_details": {
"status": "installed",
"installed_count": 500,
"total_devices_count": 1000
}
}
]
},
{
"type": "NPSExtension",
"display_name": "IDProtection NPS Extension",
"endpoint_name": "NPS",
"download_url": "https://idprotection.manageengine.com/static_downloads/nps/2.0.0/IDProtectionNPSExtension.zip",
"version": "2.0.0",
"installation_key": "1234567890abcdef",
"installation_details": {
"status": "installed"
}
},
{
"type": "IISModule",
"display_name": "IDProtection OWA Connector",
"endpoint_name": "IIS",
"download_url": "https://idprotection.manageengine.com/static_downloads/iis/2.0.0/IDProtectionIISModule.zip",
"version": "2.0.0",
"installation_key": "1234567890abcdef",
"installation_details": {
"status": "installed"
}
}
]
}
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Regenerate Installation Key for IDP Agent
Regenerates the installation key for a specific IDP agent type.
OAuth Scope : id360.conditional_access_policy.write,id360.conditional_access_policy.all
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/regenerate-install-key"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/regenerate-install-key")
.post(null)
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'POST',
headers: {
Accept: 'application/json',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/regenerate-install-key', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("id360.manageengine.com")
headers = {
'Accept': "application/json",
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
conn.request("POST", "/api/v1/protection/agents-info/DeviceAgent/regenerate-install-key", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "POST",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/protection/agents-info/DeviceAgent/regenerate-install-key",
"headers": {
"Accept": "application/json",
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request POST \
--url https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/regenerate-install-key \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
{
"data": {
"installation_key": "abcdef1234567890"
}
}
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Download IDP Agent for a Specific Type
Downloads the IDP agent for a specific type.
OAuth Scope : id360.conditional_access_policy.read,id360.conditional_access_policy.all
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/download"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/download")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Accept: 'application/json',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/download', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("id360.manageengine.com")
headers = {
'Accept': "application/json",
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
conn.request("GET", "/api/v1/protection/agents-info/DeviceAgent/download", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/protection/agents-info/DeviceAgent/download",
"headers": {
"Accept": "application/json",
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/download \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
"IDProtectionAgent.msi file"
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}
Download IDP Device Agent for a Specific Platform
Downloads the IDP Device Agent for a specific platform.
OAuth Scope : id360.conditional_access_policy.read,id360.conditional_access_policy.all
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/download/windows"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/download/windows")
.get()
.addHeader("Accept", "application/json")
.addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
.build();
Response response = client.newCall(request).execute();
const options = {
method: 'GET',
headers: {
Accept: 'application/json',
Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
}
};
fetch('https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/download/windows', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import http.client
conn = http.client.HTTPSConnection("id360.manageengine.com")
headers = {
'Accept': "application/json",
'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
conn.request("GET", "/api/v1/protection/agents-info/DeviceAgent/download/windows", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
const http = require("https");
const options = {
"method": "GET",
"hostname": "id360.manageengine.com",
"port": null,
"path": "/api/v1/protection/agents-info/DeviceAgent/download/windows",
"headers": {
"Accept": "application/json",
"Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
curl --request GET \
--url https://id360.manageengine.com/api/v1/protection/agents-info/DeviceAgent/download/windows \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
"IDProtectionAgent.msi file"
{
"error": {
"code": "00000101",
"title": "Unauthorized",
"detail": "The OAuth token is invalid."
}
}
{
"error": {
"code": "00000000",
"title": "Internal Server Error",
"detail": "An unexpected internal error has occurred on the server. Please try again later."
}
}