## Endpoint: `/api/wiz_group/`
**Method**: GET
**Description**: Fetch all alert groups for a specific customer when accessing the "Operations/Alert Groups" section.
### Parameters
| Parameter | Type | Required | Description | Example Value |
| ------------- | ------ | -------- | --------------------------------------------------------- | ----------------------------------- |
| `format` | string | No | Specifies the response format | `json` |
| `customer` | int | Yes | The ID of the customer for which alert groups are fetched | `54` |
| `pagination` | string | No | Encoded JSON string for handling pagination | `{"start_id":null, "hasMore":true}` |
| `request_key` | string | Yes | A unique key for tracking the request | `abc123` |
| `searched` | string | No | Encoded JSON string used for search filters | `{"general":"test"}` |
| `sorting` | string | No | Specifies the field by which results are sorted | `-last_updated` |
### Headers
| Header | Type | Required | Description | Example Value |
| ------ | ------ | -------- | ------------------------------- | ---------------- |
| Authorization | string | Yes | Bearer token for authentication | `Bearer <token>` |
### Example Response
{
"items": [
{
"id": <GROUP1_ID>,
"name": "<GROUP1_NAME>",
... GROUP1 DETAILS ...
},
{
"id": <GROUP2_ID>,
"name": "<GROUP2_NAME>",
... GROUP2 DETAILS ...
}
],
"pagination": {
"start_id": null,
"hasMore": false,
"total": 0
},
}
---
## Endpoint: `/api/wiz_group/{id}/`
**Method**: GET
**Description**: Retrieve details of a specific alert group by ID.
### Parameters
| Parameter | Type | Required | Description | Example Value |
| --------- | ------ | -------- | ------------------------------------- | ------------- |
| `id` | int | Yes | Unique identifier for the alert group | `12345` |
### Headers
| Header | Type | Required | Description | Example Value |
| --------------- | ------ | -------- | ------------------------------- | ---------------- |
| Authorization | string | Yes | Bearer token for authentication | `Bearer <token>` |
### Example Response
`Expanded details about the group (id)
---
## Endpoint: `/api/wiz_group/{id}/`
**Method**: PUT
**Description**: Update details of a specific alert group by ID.
### Parameters
| Parameter | Type | Required | Description | Example Value |
| --------- | ------ | -------- | ------------------------------------- | ------------- |
| `id` | int | Yes | Unique identifier for the alert group | `12345` |
### Headers
| Header | Type | Required | Description | Example Value |
| --------------- | ------ | -------- | ------------------------------- | ---------------- |
| Authorization | string | Yes | Bearer token for authentication | `Bearer <token>` |
### Request Payload
{
"params": {
"customer_id": "{customer_id}",
"description": "{description}",
"name": "{group_name}",
"id": "{group_id}",
"rules": [
{
... RULES ...
}
],
"group_ids": [],
"template_ids": [],
"search_query": "[0]"
}
}
### Example Response
`1`
`This response means that the request has succeeded`
---
## Endpoint: `/api/wiz_group/{id}/`
**Method**: DELETE
**Description**: Delete a specific alert group by ID.
### Parameters
| Parameter | Type | Required | Description | Example Value |
| --------- | ------ | -------- | ------------------------------------- | ------------- |
| `id` | int | Yes | Unique identifier for the alert group | `12345` |
### Headers
| Header | Type | Required | Description | Example Value |
| --------------- | ------ | -------- | ------------------------------- | ---------------- |
| Authorization | string | Yes | Bearer token for authentication | `Bearer <token>` |
### Example Response
{
"error": {}
}
This response means that the request succeeded
---
## Endpoint: `/api/wiz_group/{id}/check_delete/`
**Method**: POST
**Description**: Check if an alert group can be safely deleted before performing the deletion.
### Parameters
| Parameter | Type | Required | Description | Example Value |
| --------- | ------ | -------- | ------------------------------------- | ------------- |
| `id` | int | Yes | Unique identifier for the alert group | `12345` |
### Headers
| Header | Type | Required | Description | Example Value |
| --------------- | ------ | -------- | ------------------------------- | ---------------- |
| Authorization | string | Yes | Bearer token for authentication | `Bearer <token>` |
### Example Response
{
"kpis": [],
"groups": [],
"trends": []
}
---
## Endpoint: `/api/wiz_group/`
**Method**: POST
**Description**: Create new alert groups.
### Parameters
| Parameter | Type | Required | Description | Example Value |
| --------- | ---- | -------- | ----------- | ------------- |
| None | - | - | No parameters required | - |
### Headers
| Header | Type | Required | Description | Example Value |
| ------------- | ------ | -------- | ------------------------------- | ---------------- |
| Authorization | string | Yes | Bearer token for authentication | `Bearer <token>` |
### Request Payload
{
"params": {
"customer_id": "{customer_id}",
"description": "{description}",
"name": "{group_name}",
"id": "{group_id}",
"rules": [
{
... RULES ...
}
],
"group_ids": [],
"template_ids": [],
"search_query": "[0]"
}
}
### Example Response
{
"id": <ID_OF_CREATED_GROUP>
}
---