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

# Get Alert Config

Use this API to read the workspace's stored alert settings.

# Endpoint

`POST https://api.velt.dev/v2/memory/alerts/config/get`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

#### Params

**data** `object` *required*

No fields required. Send an empty object.

## **Example Requests**

#### Get the alert config

```JSON theme={null}
{
  "data": {}
}
```

# Response

Only `enabled` is always present. `maxAlertsPerWeek`, `enabledAlertTypes`, and `severityThreshold` appear only after you set them with [Update Alert Config](https://velt.dev/docs/api-reference/rest-apis/v2/memory/alerts/config/update.md). A workspace that has never updated the config gets `{ "enabled": true }`. `enabledAlertTypes` holds alert types: `anomaly`, `configuration_drift`, `emerging_standard`, or `standards_drift`.

These values are stored and returned as sent. They are not applied to alert generation today. Alerts are capped at 3 per rolling 7 days per workspace.

#### Success Response

```JSON theme={null}
{
  "result": {
    "enabled": true,
    "maxAlertsPerWeek": 5,
    "enabledAlertTypes": ["anomaly", "standards_drift"],
    "severityThreshold": "medium"
  }
}
```

#### Failure Response

```JSON theme={null}
{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}
```

```js theme={null}
{
  "result": {
    "enabled": true,
    "maxAlertsPerWeek": 5,
    "enabledAlertTypes": ["anomaly", "standards_drift"],
    "severityThreshold": "medium"
  }
}
```


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