> ## 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.

# Slide API

> Work Slide alert tickets against each system's backups and verifications, resolve alerts, start backups, run file restores and virtual machines, and check backups across clients

The common use is a ticket from a Slide alert email in your PSA: the agent reads the alert the email links to, then the protected system's backups and snapshots since, and notes on the ticket the error, the boot, filesystem or service verification result, and whether a later backup or verification succeeded. When the system has recovered, it can resolve the alert in Slide. A scheduled agent can check every client's open alerts, offline Slide Boxes and storage once a day.

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

## What It Does

* Read alerts (backup failed, scheduled backup missed, agent or Slide Box not checking in, storage low or critical, out of date, duplicate agent connection) and mark them resolved
* Read each backup's status, error code and message, and start a backup
* Read snapshots with their boot, filesystem and service verification results, the boot screenshot, and which services failed to start
* Read and change protected systems (Slide Agents): schedule, pauses, retention, volumes, alert settings and the services boot verification checks; pair new systems
* Read and change Slide Boxes: check-in, storage, versions, network settings and VLANs; reboot
* Search files across snapshots, run file restores and push a file back to the protected system
* Start, change and stop virtual machines and image exports from a snapshot, and manage disaster recovery networks
* Read and change clients, read your account, users and audit log, and read invoices, credit memos and subscriptions

## Permission Groups

| Group | Covers |
| - | - |
| Alerts | Alerts and marking them resolved |
| Backups and Snapshots | Backups, snapshots and their verification results, and starting a backup |
| Protected Systems | Protected systems, their settings and the services boot verification checks; pairing new systems |
| Agent Passphrases | Adding and removing a protected system's passphrases (write only) |
| Slide Boxes | Slide Boxes, their network settings and VLANs, rebooting and powering off |
| File Restores | File search, file restores, browsing them and pushing a file back |
| Virtual Machines and Image Exports | Virtual machines and image exports booted or exported from a snapshot |
| Disaster Recovery Networks | Disaster recovery networks with their IPsec connections, WireGuard peers and port forwards |
| Clients | Clients: adding, renaming and deleting |
| Account, Users and Audit Logs | Your account and its alert email list, users and the audit log |
| Billing | Invoices, credit memos and subscriptions (read only) |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read except passphrases | No write is allowed |
| **Helpdesk** | Reads, and resolving alerts | Starting a backup, and a file restore. Slide Boxes, systems, VMs and networks stay read only; passphrases and billing stay off |
| **IT Admin** | Every read and every write but the next column | Passphrases, disaster recovery networks and the account's alert email list |
| **Full Automation** | Every read and write | Only the writes that always ask (below) |

## Safety Controls

| Control | Behavior |
| - | - |
| **Always ask** | Deleting a client, powering off a Slide Box (only someone on site can turn it on again), and a change that pauses a system's backups or one of its alerts with no end always need a technician's approval, whatever the profile |
| **Hidden credentials** | Passwords, passphrases, pre-shared and private keys, pair codes, download links and remote console addresses read `[hidden by Neo]` in every answer, and Neo refuses a write that sends that value back |
| **Ticket scope** | On a ticket, the agent reaches only the Slide client mapped to the ticket's company, by a name match or one you confirmed. A call goes out only after Slide's own records show that every agent, Slide Box, alert, snapshot or restore it names belongs to that client. Lists of every client's alerts, backups or restores, the client list, users, the account and billing are for runs with no ticket company, such as a scheduled check or a chat |
| **Files** | Neo does not download invoice or credit memo PDFs or user pictures; the invoice and credit memo lists carry the same amounts |


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