Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.
TypeScript acmeagentsai-agentscertificate-managementdevsecopsenvironment-variableskubernetesopen-sourcepampkipostgresprivate-caprivileged-access-managementsecret-managementsecret-managersecretssecrets-managementsecuritysecurity-toolsvault
docs(alerting): add alerting api reference
Carlos Monastyrski159ec5c06bfc
diff --git a/backend/src/lib/api-docs/constants.ts b/backend/src/lib/api-docs/constants.tsindex c3419e9a4f..c29a979bab 100644--- a/backend/src/lib/api-docs/constants.ts+++ b/backend/src/lib/api-docs/constants.ts@@ -69,6 +69,7 @@ export enum ApiDocsTags {Integrations = "Integrations",ServiceTokens = "Service Tokens",AuditLogs = "Audit Logs",+ Alerting = "Alerting",PkiCertificateAuthorities = "PKI Certificate Authorities",PkiCertificates = "PKI Certificates",PkiCertificatePolicies = "PKI Certificate Policies",diff --git a/backend/src/server/routes/v1/alert-router.ts b/backend/src/server/routes/v1/alert-router.tsindex dd12a83e2b..b4b56415c8 100644--- a/backend/src/server/routes/v1/alert-router.ts+++ b/backend/src/server/routes/v1/alert-router.ts@@ -1,7 +1,7 @@import { FastifyRequest } from "fastify";import { z } from "zod";-import { ALERTING } from "@app/lib/api-docs";+import { ALERTING, ApiDocsTags } from "@app/lib/api-docs";import { readLimit, writeLimit } from "@app/server/config/rateLimiter";import { getTelemetryDistinctId } from "@app/server/lib/telemetry";import { verifyAuth } from "@app/server/plugins/auth/verify-auth";@@ -72,7 +72,9 @@ export const registerAlertRouter = async (server: FastifyZodProvider) => {url: "/",config: { rateLimit: writeLimit },schema: {+ hide: false,operationId: "createAlert",+ tags: [ApiDocsTags.Alerting],description: "Create an alert that notifies its channels when an event happens to a resource.",body: z.object({name: z.string().min(1).max(255).describe(ALERTING.CREATE.name),@@ -175,7 +177,9 @@ export const registerAlertRouter = async (server: FastifyZodProvider) => {url: "/",config: { rateLimit: readLimit },schema: {+ hide: false,operationId: "listAlerts",+ tags: [ApiDocsTags.Alerting],description: "List the alerts on a resource type.",querystring: z.object({resourceType: z.string().trim().min(1).max(255).describe(ALERTING.LIST.resourceType),@@ -207,7 +211,9 @@ export const registerAlertRouter = async (server: FastifyZodProvider) => {url: "/:alertId",config: { rateLimit: readLimit },schema: {+ hide: false,operationId: "getAlertById",+ tags: [ApiDocsTags.Alerting],description: "Get an alert by ID.",params: z.object({ alertId: z.string().uuid().describe(ALERTING.GET.alertId) }),response: { 200: z.object({ alert: AlertResponseSchema }) }@@ -230,7 +236,9 @@ export const registerAlertRouter = async (server: FastifyZodProvider) => {url: "/:alertId",config: { rateLimit: writeLimit },schema: {+ hide: false,operationId: "updateAlert",+ tags: [ApiDocsTags.Alerting],description: "Update an alert.",params: z.object({ alertId: z.string().uuid().describe(ALERTING.UPDATE.alertId) }),body: z.object({@@ -275,7 +283,9 @@ export const registerAlertRouter = async (server: FastifyZodProvider) => {url: "/:alertId",config: { rateLimit: writeLimit },schema: {+ hide: false,operationId: "deleteAlert",+ tags: [ApiDocsTags.Alerting],description: "Delete an alert and its channels.",params: z.object({ alertId: z.string().uuid().describe(ALERTING.DELETE.alertId) }),response: { 200: z.object({ alert: z.object({ id: z.string().uuid() }) }) }diff --git a/docs/api-reference/endpoints/alerts/create.mdx b/docs/api-reference/endpoints/alerts/create.mdxnew file mode 100644index 0000000000..b097cc550c--- /dev/null+++ b/docs/api-reference/endpoints/alerts/create.mdx@@ -0,0 +1,4 @@+---+title: "Create alert"+openapi: "POST /api/v1/alerts"+---diff --git a/docs/api-reference/endpoints/alerts/delete.mdx b/docs/api-reference/endpoints/alerts/delete.mdxnew file mode 100644index 0000000000..79cdc7d851--- /dev/null+++ b/docs/api-reference/endpoints/alerts/delete.mdx@@ -0,0 +1,4 @@+---+title: "Delete alert"+openapi: "DELETE /api/v1/alerts/{alertId}"+---diff --git a/docs/api-reference/endpoints/alerts/get-by-id.mdx b/docs/api-reference/endpoints/alerts/get-by-id.mdxnew file mode 100644index 0000000000..04c22a6a6f--- /dev/null+++ b/docs/api-reference/endpoints/alerts/get-by-id.mdx@@ -0,0 +1,4 @@+---+title: "Get alert by ID"+openapi: "GET /api/v1/alerts/{alertId}"+---diff --git a/docs/api-reference/endpoints/alerts/list.mdx b/docs/api-reference/endpoints/alerts/list.mdxnew file mode 100644index 0000000000..338f0bb629--- /dev/null+++ b/docs/api-reference/endpoints/alerts/list.mdx@@ -0,0 +1,4 @@+---+title: "List alerts"+openapi: "GET /api/v1/alerts"+---diff --git a/docs/api-reference/endpoints/alerts/update.mdx b/docs/api-reference/endpoints/alerts/update.mdxnew file mode 100644index 0000000000..8cb73f6ccb--- /dev/null+++ b/docs/api-reference/endpoints/alerts/update.mdx@@ -0,0 +1,4 @@+---+title: "Update alert"+openapi: "PATCH /api/v1/alerts/{alertId}"+---diff --git a/docs/docs.json b/docs/docs.jsonindex 2684b5e32e..161e733ef3 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -2650,6 +2650,16 @@"api-reference/endpoints/audit-logs/update-project-audit-log-settings"]},+ {+ "group": "Alerts",+ "pages": [+ "api-reference/endpoints/alerts/list",+ "api-reference/endpoints/alerts/create",+ "api-reference/endpoints/alerts/get-by-id",+ "api-reference/endpoints/alerts/update",+ "api-reference/endpoints/alerts/delete"+ ]+ },{"group": "Events","pages": [@@ -5668,4 +5678,4 @@"destination": "/documentation/platform/dynamic-secrets/overview"}]-}\ No newline at end of file+}