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

# Redstor API

> Read Redstor backup and restore status so an agent can confirm a backup failure and close the ticket once every failed account has backed up since, and manage clients and subscriptions

The Redstor API tool gives Neo agents access to Redstor's RedApp through the RedAPI. The common use is a backup failure ticket, such as a scheduled Redstor backup error report: the agent finds the backup accounts it covers, checks whether each has backed up successfully since, and closes the ticket or explains which accounts are still failing.

<Info>
  Automatically enabled when you configure Redstor permissions in your agent workflow.
</Info>

## What It Does

* Read the recent backups of each backup account of a client, with their result (failed, succeeded, with warnings, with errors) and time
* Read the error messages of an account's backups
* Count backups per product and per client, failed and missed ones included
* Read the outcome of recent restores
* Find a backup account by name, and list the storage regions
* Find the client from the [Organization Mapping](/integrations/redstor/overview#your-clients-are-mapped-automatically), or by name
* Add a client, enable or disable one, and add or remove a product, start a trial or convert one
* Read the data protected, seats and workloads per client, and the RedApp's users

## How the agent checks a backup error report

The agent takes the company and the time of the report, and reads each backup account of that company. An account that failed or finished with errors in the 24 hours before the report has recovered when a successful backup follows its last failure; an account that missed its backup has recovered when a successful backup follows the report. A backup that finished with warnings counts as a success only when your instructions say so, and as a failure otherwise. The agent closes the ticket only when the accounts it found match the report's counts and every one of them has recovered, with an internal note that names them. When an account is still failing, it leaves the ticket open with that account's latest error.

## Permission Groups

| Group | Access levels | Covers |
| - | - | - |
| Backup & Restore Status | Disabled, Read Only | Backup and restore results, backup errors, backup accounts, storage regions |
| Customers | Disabled, Read Only, Read / Write | Your RedApp clients |
| Products & Subscriptions | Disabled, Read Only, Read / Write | The product catalogue and each client's subscriptions and trials |
| Consumption | Disabled, Read Only | Data protected, seats and workloads |
| RedApp Users | Disabled, Read Only | RedApp users, and the status and expiry of a RedAPI service account's keys |

Deleting, disabling or moving a client to another partner and removing a product always ask a technician, whatever the profile, because each stops that client's backups or hands the client to someone else. Adding a sub-partner always asks too, because a sub-partner manages clients of its own. Neo reads a RedAPI service account's keys only for their status and expiry, and never creates or deletes one.

## Setup

See [Connecting Redstor to Neo](/integrations/redstor/connecting-to-neo).


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