Devices

Devices API for ManageEngine ID360

Download Devices OpenAPI Document

End Points

GET

/devices/{id}/activate

POST

/devices/{id}/deactivate

POST

/device/{id}/approve-agent

POST

/device/{id}/deny-agent

POST

/device/approve-agent

POST

/device/deny-agent

Attribute

string

Unique identifier for the device

name

string

Name of the device

os_type

string

Operating system type of the device

Allowed Values:

Windows
macOS
Linux

os_major_version

string

Major version of the operating system

os_release_name

string

Release name of the operating system

os_build_version

string

Build version of the operating system

serial_number

string

Serial number of the device

ip_address

string

IP address of the device

agent_status

string

Status of the agent installed on the device

Allowed Values:

active
inactive

agent_version

string

Version of the agent installed on the device

is_agent_outdated

boolean

Indicates if the agent is outdated

agent_installed_time

date-time

Time when the agent was installed on the device

join_type

string

Join type of the device in the directory

Allowed Values:

ADEntraHybridJoined
ADJoined
EntraJoined
ID360Joined

domain

string

Domain of the device

tenant

string

Tenant of the device

dns_hostname

string

DNS hostname of the device

container

string

Container in which the device is located

managed_by

string

Group that manages the device

owner

string

Owner of the device

mdm

string

Mobile Device Management (MDM) solution managing the device

description

string

Description of the device

last_contact_time

date-time

Last time the device contacted the server

{
    "id": "2000000000006",
    "name": "DESKTOP-HYBRID-006",
    "os_type": "Windows",
    "os_major_version": "10",
    "os_release_name": "19H2",
    "os_build_version": "18363.2274",
    "serial_number": "VMJ8K2L9P4",
    "ip_address": "192.168.1.50",
    "agent_status": "active",
    "agent_version": "1.4",
    "is_agent_outdated": true,
    "agent_installed_time": "2024-06-01T10:30:00+05:30",
    "join_type": "ADEntraHybridJoined",
    "domain": "corp.contoso.com",
    "tenant": "contoso.onmicrosoft.com",
    "dns_hostname": "desktop-hybrid-006.corp.contoso.com",
    "container": "CN=Computers,DC=corp,DC=contoso,DC=com",
    "managed_by": "CN=Domain Admins,OU=Groups,DC=corp,DC=contoso,DC=com",
    "owner": "Admin wamsubdom",
    "mdm": "Microsoft Intune",
    "description": "Finance workstation with hybrid domain join",
    "last_contact_time": "2024-07-26T08:45:00+05:30"
}

List Devices

The List Devices API can be used to get the list of devices in your account.
OAuth Scope : id360.device.READ,id360.device.ALL

Query Parameters

limit

Limit the number of devices to be fetched

fields

Select the fields to be fetched in the response.

filter

Filter devices based on a the provided SCIM filter query. Refer to filter section for more details
eg: name eq "John" and os_type eq "Windows"

sort

Sort the devices based on the provided field. The default sort order is ascending. To sort in descending order, prefix the field with a - (hyphen).
eg: name,-os_type

cursor

Cursor for pagination. Use the next_cursor value from the previous response to fetch the next set of results.

Request Example

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/devices"
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/devices")
  .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/devices', 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/devices", 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/devices",
  "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/devices \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": [
        {
            "id": "2000000000001",
            "hostname": "DESKTOP-WIN11-001",
            "os_type": "Windows",
            "os_major_version": "11",
            "os_release_name": "22H2",
            "os_build_version": "22621.2428",
            "serial_number": "FVFH2345ABC123",
            "ip_address": "192.168.1.45",
            "agent_status": "active",
            "agent_version": "1.4",
            "join_type": "IDPJoined",
            "is_deactivated": false,
            "device_accounts": {
                "total_local_accounts": 3,
                "linked_local_accounts": 1
            },
            "date_added": "2024-01-15T09:00:00Z",
            "last_contact_time": "2024-07-26T10:30:00Z"
        },
        {
            "id": "2000000000002",
            "name": "LAPTOP-MAC-002",
            "os_type": "macOS",
            "os_major_version": "14",
            "os_build_version": "14.1.2 (23B92)",
            "serial_number": "C02YX1234GHV",
            "ip_address": "192.168.1.46",
            "agent_status": "pending",
            "agent_version": "1.3",
            "join_type": "IDPJoined",
            "is_deactivated": false,
            "device_accounts": {
                "total_local_accounts": 2,
                "linked_local_accounts": 1
            },
            "date_added": "2024-02-01T14:30:00Z",
            "last_contact_time": "2024-07-26T10:25:00Z"
        },
        {
            "id": "2000000000004",
            "name": "WORKSTATION-LINUX-004",
            "os_type": "Linux",
            "os_distribution": "Ubuntu",
            "os_major_version": "22.04",
            "os_build_version": "5.19.0-76-generic",
            "serial_number": "VMware-56 4d 8b 2f",
            "ip_address": "192.168.1.48",
            "agent_status": "pending",
            "agent_version": "1.4",
            "join_type": "IDPJoined",
            "is_deactivated": false,
            "device_accounts": {
                "total_local_accounts": 4,
                "linked_local_accounts": 0
            }
        },
        {
            "id": "2000000000005",
            "name": "LAPTOP-ENTRA-005",
            "os_type": "Windows",
            "os_major_version": "11",
            "os_release_name": "22H2",
            "os_build_version": "22621.3007",
            "serial_number": "PF3K8MN2",
            "ip_address": "192.168.1.49",
            "agent_status": "active",
            "agent_version": "1.5",
            "join_type": "EntraJoined",
            "tenant": "contoso.onmicrosoft.com",
            "description": "Marketing team laptop with Entra ID integration",
            "date_added": "2024-05-12T13:45:00Z",
            "last_contact_time": "2024-07-26T11:20:00Z"
        },
        {
            "id": "2000000000006",
            "name": "DESKTOP-HYBRID-006",
            "os_type": "Windows",
            "os_major_version": "10",
            "os_release_name": "19H2",
            "os_build_version": "18363.2274",
            "serial_number": "VMJ8K2L9P4",
            "ip_address": "192.168.1.50",
            "agent_status": "active",
            "agent_version": "1.4",
            "join_type": "ADEntraHybridJoined",
            "tenant": "corp.contoso.com",
            "domain": "contoso.onmicrosoft.com",
            "description": "Finance workstation with hybrid domain join",
            "last_contact_time": "2024-07-26T08:45:00Z"
        }
    ],
    "meta": {
        "cursor": null,
        "next_cursor": null,
        "is_last": true,
        "limit": 100,
        "total_no_of_objects": 2
    }
}

{
    "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."
    }
}

Get Device

The Get Device API can be used to get the details of a specific device in your account.
OAuth Scope : id360.device.READ,id360.device.ALL

Query Parameters

fields

Select the fields to be fetched in the response.

Request Example

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/devices/2000000000001"
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/devices/2000000000001")
  .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/devices/2000000000001', 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/devices/2000000000001", 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/devices/2000000000001",
  "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/devices/2000000000001 \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "id": "2000000000006",
    "name": "DESKTOP-HYBRID-006",
    "os_type": "Windows",
    "os_major_version": "10",
    "os_release_name": "19H2",
    "os_build_version": "18363.2274",
    "serial_number": "VMJ8K2L9P4",
    "ip_address": "192.168.1.50",
    "agent_status": "active",
    "agent_version": "1.4",
    "is_agent_outdated": true,
    "agent_installed_time": "2024-06-01T10:30:00+05:30",
    "join_type": "ADEntraHybridJoined",
    "domain": "corp.contoso.com",
    "tenant": "contoso.onmicrosoft.com",
    "dns_hostname": "desktop-hybrid-006.corp.contoso.com",
    "container": "CN=Computers,DC=corp,DC=contoso,DC=com",
    "managed_by": "CN=Domain Admins,OU=Groups,DC=corp,DC=contoso,DC=com",
    "owner": "Admin wamsubdom",
    "mdm": "Microsoft Intune",
    "description": "Finance workstation with hybrid domain join",
    "last_contact_time": "2024-07-26T08:45:00+05:30"
}

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Delete Device/ Uninstall Device Agent

This api has 2 behaviors:

If the device is enrolled through ID360, it will delete the device and uninstall the agent.
If the device is enrolled through Entra/AD, it will only uninstall the agent and not delete the device.

OAuth Scope : id360.device.DELETE,id360.device.WRITE,id360.device.ALL

Request Example

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/devices/2000000000001"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://id360.manageengine.com/api/v1/devices/2000000000001")
  .delete(null)
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Accept: 'application/json',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://id360.manageengine.com/api/v1/devices/2000000000001', 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("DELETE", "/api/v1/devices/2000000000001", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "id360.manageengine.com",
  "port": null,
  "path": "/api/v1/devices/2000000000001",
  "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 DELETE \
  --url https://id360.manageengine.com/api/v1/devices/2000000000001 \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Access Denied",
        "detail": "You do not have permission to do this operation."
    }
}

{
    "error": {
        "code": 71,
        "title": "Invalid Parameter",
        "detail": "Value for mandatory field 'email' is not provided"
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Activate Device

The Activate Device API can be used to activate the device allowing users linked through IDP to log in to the device.
OAuth Scope : id360.device.WRITE,id360.device.ALL

Request Example

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/devices/2000000000001/activate"
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/devices/2000000000001/activate")
  .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/devices/2000000000001/activate', 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/devices/2000000000001/activate", 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/devices/2000000000001/activate",
  "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/devices/2000000000001/activate \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Deactivate Device

The Deactivate Device API can be used to deactivate the device and users linked through IDP will not be able to access the device.
OAuth Scope : id360.device.WRITE,id360.device.ALL

Request Example

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/devices/2000000000001/deactivate"
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/devices/2000000000001/deactivate")
  .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/devices/2000000000001/deactivate', 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/devices/2000000000001/deactivate", 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/devices/2000000000001/deactivate",
  "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/devices/2000000000001/deactivate \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Approve Device Agent

The Approve Device Agent API can be used to approve the IDP agent installed on the given device.
OAuth Scope : id360.device.WRITE,id360.device.ALL

Request Example

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/device/2000000000001/approve-agent"
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/device/2000000000001/approve-agent")
  .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/device/2000000000001/approve-agent', 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/device/2000000000001/approve-agent", 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/device/2000000000001/approve-agent",
  "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/device/2000000000001/approve-agent \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Deny Device Agent

The Deny Device Agent API can be used to deny the IDP agent installed on the given device.
OAuth Scope : id360.device.WRITE,id360.device.ALL

Request Example

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/device/2000000000001/deny-agent"
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/device/2000000000001/deny-agent")
  .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/device/2000000000001/deny-agent', 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/device/2000000000001/deny-agent", 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/device/2000000000001/deny-agent",
  "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/device/2000000000001/deny-agent \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "error": {
        "code": "00000101",
        "title": "Unauthorized",
        "detail": "The OAuth token is invalid."
    }
}

{
    "error": {
        "code": "********",
        "title": "Device Not Found",
        "detail": "No device found with ID 2000000000001."
    }
}

{
    "error": {
        "code": "00000000",
        "title": "Internal Server Error",
        "detail": "An unexpected internal error has occurred on the server. Please try again later."
    }
}

Bulk Approve Device Agent

Bulk Approve Device Agent API can be used to approve the IDP agents installed on the given devices.
OAuth Scope : id360.device.WRITE,id360.device.ALL

Query Parameters

ids

(Required)

Comma-separated list of resource IDs.
eg: 2000000000011,2000000000012

Request Example

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/device/approve-agent?ids=2000000000011,2000000000012"
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/device/approve-agent?ids=2000000000011%2C2000000000012")
  .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/device/approve-agent?ids=2000000000011%2C2000000000012', 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/device/approve-agent?ids=2000000000011%2C2000000000012", 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/device/approve-agent?ids=2000000000011%2C2000000000012",
  "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/device/approve-agent?ids=2000000000011%2C2000000000012' \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": [
        {
            "resource_id": "2000000000001",
            "status": 204
        },
        {
            "resource_id": "2000000000002",
            "status": 404,
            "error": {
                "code": "****",
                "title": "Device Not Found",
                "detail": "No device found with ID 2000000000001."
            }
        }
    ]
}

{
    "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."
    }
}

Bulk Deny Device Agent

Bulk Deny Device Agent API can be used to deny the IDP agents installed on the given devices.
OAuth Scope : id360.device.WRITE,id360.device.ALL

Query Parameters

ids

(Required)

Comma-separated list of resource IDs.
eg: 2000000000011,2000000000012

Request Example

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/device/deny-agent?ids=2000000000011,2000000000012"
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/device/deny-agent?ids=2000000000011%2C2000000000012")
  .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/device/deny-agent?ids=2000000000011%2C2000000000012', 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/device/deny-agent?ids=2000000000011%2C2000000000012", 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/device/deny-agent?ids=2000000000011%2C2000000000012",
  "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/device/deny-agent?ids=2000000000011%2C2000000000012' \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "data": [
        {
            "resource_id": "2000000000001",
            "status": 204
        },
        {
            "resource_id": "2000000000002",
            "status": 404,
            "error": {
                "code": "****",
                "title": "Device Not Found",
                "detail": "No device found with ID 2000000000001."
            }
        }
    ]
}

{
    "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."
    }
}