- Overview
- Reference Guide
- Setup & Architecture
- Release Notes
- Workflow
- API Reference
- Integration Guide
- Discovery Agent Setup Guide
Alerts
The Alerts endpoints control who receives certificate alerts, resend certificate emails, and manage the Microsoft Teams notification configuration.
For the corresponding user interface, refer to the Miscellaneous > Service Setup section.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /alerts/resend_certificate_email | Resend certificate email. |
| GET | /alerts/toggle_alerts | Get alert settings. |
| POST | /alerts/toggle_alerts | Update alert audience. |
| GET | /msteams | Get MS Teams config. |
| POST | /msteams | Update MS Teams config. |
GET /alerts/resend_certificate_email
Sends the certificate email of a certificate again.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|---|---|---|---|
eid |
Query | integer | No | Enrollment ID (EID) of the certificate in CertSecure Manager. |
SerialNumber |
Query | string | No | Serial number of the certificate. |
Example Request
curl -X GET "https://<certsecure-backend-url>/alerts/resend_certificate_email" \
-H "Authorization: Bearer <token>"Responses
| Status Code | Description |
|---|---|
| 200 | Queued. |
GET /alerts/toggle_alerts
Returns who receives certificate alerts: all users, the owner, or the watchers.
Example Request
curl -X GET "https://<certsecure-backend-url>/alerts/toggle_alerts" \
-H "Authorization: Bearer <token>"Example Response
{
"alerts_enabled": "all"
}Responses
| Status Code | Description |
|---|---|
| 200 | Settings. |
POST /alerts/toggle_alerts
Sets who receives certificate alerts: all, owner, or watcher.
Request Body (application/json)
| Field | Type | Required | Description |
|---|---|---|---|
Alerts |
string | Yes | Allowed values: all, owner, watcher. |
Example Request
curl -X POST "https://<certsecure-backend-url>/alerts/toggle_alerts" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"Alerts": "string"}'Responses
| Status Code | Description |
|---|---|
| 200 | The settings were saved. |
GET /msteams
Returns the Microsoft Teams webhook configuration and the events that are posted to Teams.
Example Request
curl -X GET "https://<certsecure-backend-url>/msteams" \
-H "Authorization: Bearer <token>"Example Response
{
"Name": "MSTeams",
"url": "https://<teams-webhook-url>",
"config": {
"Creation": true,
"Expiration": true,
"ExpirationAlerts": true,
"Renewal": true,
"Revocation": true
}
}Responses
| Status Code | Description |
|---|---|
| 200 | The configuration is returned. |
POST /msteams
Updates the Microsoft Teams webhook configuration.
Request Body (application/json)
The request body is a JSON object that contains the settings to save.
Example Request
curl -X POST "https://<certsecure-backend-url>/msteams" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{}'Responses
| Status Code | Description |
|---|---|
| 200 | The settings were saved. |