> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Zorus API

> Work Zorus from Neo: count each customer's endpoints, triage unblock requests, restart filtering, isolate or release a device

The common uses are endpoint counts per customer, for a QBR or a billing check, and a "Requests to Unblock Domain" ticket, where the agent finds the user's request, checks the site and hands the technician a recommendation and the steps to approve or deny it in the Zorus portal.

> [!NOTE]
>
> Automatically enabled when you configure Zorus permissions in your agent workflow.

## What It Does

* Count each customer's endpoints: installed, filtering, CyberSight and network seats
* List endpoints with their OS, agent version and state, filtering state and last seen time
* Read your users' active unblock requests: the site, why Zorus blocked it, its categories, the user, the device and their reason
* Restart an endpoint's filtering service, enable or disable an endpoint, isolate it and release it
* Create the deployment token that installs Zorus into a group
* Read groups and policies, and create customers and groups

The Zorus API has no call that approves or denies an unblock request, or that changes a policy, so a technician makes those decisions in the Zorus portal.

## Permission Groups

| Group | Covers |
| - | - |
| Customers & Groups | Customers with their endpoint counts, groups and the policies they use; creating a customer or a group |
| Endpoints | Endpoints and their state; restarting the filtering service, enabling, disabling, isolating and releasing an endpoint |
| Unblock Requests | Your users' active unblock requests (read only) |
| Deployment Tokens | Creating the token that installs Zorus into a group (no read) |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Every endpoint action; no other write is allowed |
| **IT Admin** | Every read, endpoint actions and deployment tokens | Creating a customer or a group, and disabling an endpoint |
| **Full Automation** | Every read and write | Disabling an endpoint |

## Safety Controls

| Control | Behavior |
| - | - |
| **The ticket's customer only** | On a run for a ticket that names a company, Neo sends a call only when every Zorus customer it names is the one the ticket's company is mapped to. A search names the customer in its filters; an endpoint action or a deployment token names it too, and Neo reads the endpoint or group first to confirm it belongs to that customer. Creating a customer is refused on a ticket run |
| **Always asks a technician** | Disabling an endpoint, which turns its web filtering off. Every other change follows the group's approval setting |
| **Deployment tokens** | The token is kept out of the run log, and a sandbox script cannot create one |
| **Isolation passphrase** | Masked in the run log and in test mode reports |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.