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

# Introduction

> Sync alert data from your security platforms into Rilevera with the Rilevera API.

Use the Rilevera API to sync alert data from your security platforms, such as Sumo Logic or Datadog, into Rilevera.

## Base URL

Send all requests to:

```text theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
https://api.rilevera.com
```

## Authentication

Include your Rilevera API key in the `X-Api-Key` header of every request. Contact your administrator to get an API key.

```bash theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
curl -X POST https://api.rilevera.com/v1/alert-sync \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d @alerts.json
```

## Errors

Error responses return a JSON body that describes the problem:

```json theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
{
  "userMessage": "Alert not found.",
  "errorType": "NotFoundException",
  "requestId": "3f2b8c1e-5d4a-4e9b-9a7c-1b2d3e4f5a6b"
}
```

Include the `requestId` when you contact support. Some errors also include `title` and `additionalContext` fields.

| Status | Meaning |
| - | - |
| `400` | The alert data is invalid, such as a timestamp in the future. |
| `401` | The API key is missing, invalid, or expired. |
| `403` | Your API key doesn't have permission for this request. |
| `422` | The request body failed validation. The `validationErrors` field lists each invalid field. |
| `444` | The alert doesn't exist. Rilevera returns `444` instead of `404`. |
| `500` | The server couldn't complete the request. |

> [card] [Sync alerts](https://docs.rilevera.com/api-reference/alerts/sync-alerts.md)
>
> Send a batch of up to 1,000 alerts in a single request.

> [card] [Update an alert](https://docs.rilevera.com/api-reference/alerts/update-alert.md)
>
> Change the status, assignment, or resolution of a single alert.


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