> ## Documentation Index > Fetch the complete documentation index at: https://docs.flashduty.com/llms.txt > Use this file to discover all available pages before exploring further. # List alert pipelines > Return the alert processing pipelines configured for multiple integrations. ## Restrictions | Aspect | Value | | ----------- | ------------------------------------------------------------- | | Rate limits | **1,000 requests/minute**; **50 requests/second** per account | | Permissions | **Integrations Read** (`on-call`) | ## Usage * All `integration_ids` must be accessible to the caller. ## OpenAPI ````yaml /api-reference/on-call.openapi.en.json post /alert/pipeline/list openapi: 3.1.0 info: title: Flashduty Open API description: >- Public HTTP API for the Flashduty incident management platform — incidents, notification templates, channels, schedules, monitors, RUM, and platform administration. Every operation is authenticated with an `app_key` query parameter issued from the Flashduty console under Account → APP Keys. Responses follow a uniform envelope: `{ request_id, data }` on success, `{ request_id, error }` on failure. version: 1.0.0 servers: - url: https://api.flashcat.cloud description: Flashduty Open API security: - AppKeyAuth: [] tags: - name: On-call/Incidents description: '' - name: On-call/Channels description: '' - name: On-call/Alerts description: >- Search, inspect, and act on alerts. Manage card views and alert processing pipelines. - name: On-call/Integrations description: '' - name: On-call/IM integrations description: IM integration queries, such as which integrations have war room enabled. - name: On-call/Schedules description: '' - name: On-call/Calendars description: '' - name: On-call/Notification templates description: '' - name: On-call/Alert enrichment description: Custom fields, enrichment rules, and data mapping (schema, data, API). - name: On-call/Analytics description: '' - name: On-call/Status pages description: '' - name: On-call/Changes description: '' paths: /alert/pipeline/list: post: tags: - On-call/Alerts summary: List alert pipelines description: >- Return the alert processing pipelines configured for multiple integrations. operationId: alert-read-pipeline-list requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AlertPipelineListRequest' example: integration_ids: - 10001 - 10002 responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/AlertPipelineListResponse' example: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: items: - integration_id: 10001 rules: [] status: enabled creator_id: 80011 updated_by: 80011 created_at: 1710000000 updated_at: 1712000000 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/ServerError' components: schemas: AlertPipelineListRequest: type: object required: - integration_ids properties: integration_ids: type: array items: type: integer format: int64 description: Integration IDs. SuccessEnvelope: type: object description: >- Success response envelope. On every 2xx response, `request_id` identifies the call (also mirrored in the `Flashcat-Request-Id` header) and `data` holds the endpoint-specific payload. Failure responses use a different shape — see `ErrorResponse`. properties: request_id: type: string description: >- Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues. example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 data: description: Endpoint-specific payload. See each operation's 200 response schema. required: - request_id - data AlertPipelineListResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AlertPipelineItem' AlertPipelineItem: type: object description: Alert processing pipeline for an integration. properties: integration_id: type: integer format: int64 description: Integration ID this pipeline applies to. rules: type: array items: $ref: '#/components/schemas/AlertPipeline' description: Ordered list of processing rules. status: type: string description: 'Pipeline status. Possible values: `enabled`, `disabled`.' creator_id: type: integer format: int64 description: Member ID who created the pipeline. updated_by: type: integer format: int64 description: Member ID who last updated the pipeline. created_at: type: integer format: int64 description: Creation timestamp, Unix epoch seconds. updated_at: type: integer format: int64 description: Last update timestamp, Unix epoch seconds. ErrorResponse: type: object description: Response envelope for errors. `error` is required; `data` is absent. properties: request_id: type: string example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: $ref: '#/components/schemas/DutyError' required: - request_id - error AlertPipeline: type: object description: A single alert processing rule. properties: kind: type: string enum: - title_reset - description_reset - severity_reset - alert_drop - alert_inhibit description: Rule type. if: $ref: '#/components/schemas/OrFilterGroup' description: >- Optional OR-of-AND filter. When omitted, the rule applies to all alerts. settings: type: object description: >- Kind-specific settings. Shape depends on `kind`: - `title_reset`: `{ "title": "" }` - `description_reset`: `{ "description": "" }` - `severity_reset`: `{ "severity": "Critical"|"Warning"|"Info" }` - `alert_drop`: `{}` (empty object) - `alert_inhibit`: `{ "equals": ["", ...], "source_filters": }` oneOf: - $ref: '#/components/schemas/ApTitleReset' - $ref: '#/components/schemas/ApDescriptionReset' - $ref: '#/components/schemas/ApSeverityReset' - $ref: '#/components/schemas/ApAlertDrop' - $ref: '#/components/schemas/ApAlertInhibit' DutyError: type: object description: >- Error payload inside the response envelope. Present only on non-2xx responses. properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: >- Human-readable error message, localized by the caller's Accept-Language. May contain field names, IDs, or other context from the failing request. example: The specified parameter template_id is not valid. required: - code - message OrFilterGroup: type: array description: >- OR-of-AND filter tree. Outer array is a list of AND groups; the condition passes if **any** AND group matches. Within each AND group, **all** conditions must match. items: type: array description: AND group — all conditions in this array must match. items: $ref: '#/components/schemas/FilterCondition' ApTitleReset: type: object description: >- Settings for `title_reset` rule: overrides the alert title with a template string. required: - title properties: title: type: string description: >- New title template. Supports Golang template syntax referencing alert fields. ApDescriptionReset: type: object description: 'Settings for `description_reset` rule: overrides the alert description.' required: - description properties: description: type: string description: New description template. ApSeverityReset: type: object description: >- Settings for `severity_reset` rule: forces the alert severity to a fixed value. required: - severity properties: severity: type: string enum: - Critical - Warning - Info description: Target severity level. ApAlertDrop: type: object description: >- Settings for `alert_drop` rule: no additional settings required. Matched alerts are silently discarded. properties: {} ApAlertInhibit: type: object description: >- Settings for `alert_inhibit` rule: suppresses source alerts that match the filter when they share the same label values as the current alert. required: - equals - source_filters properties: equals: type: array items: type: string description: >- Label keys whose values must be equal between the source and current alert for inhibition to apply. source_filters: $ref: '#/components/schemas/OrFilterGroup' description: Filter that identifies the source alerts to inhibit. ErrorCode: type: string description: >- Flashduty error code enum. Every failed API response sets `error.code` to one of these stable wire strings. HTTP status is informational — the authoritative signal is the enum value. | Code | HTTP | Meaning | |---|---|---| | `OK` | 200 | Reserved — not returned on real errors. | | `InvalidParameter` | 400 | A required parameter is missing or failed validation. | | `BadRequest` | 400 | Generic 400 used when no more specific code fits. | | `InvalidContentType` | 400 | The `Content-Type` header is not `application/json`. | | `ResourceNotFound` | 400 | The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). | | `NoLicense` | 400 | The feature is license-gated and no active license was found. | | `ReferenceExist` | 400 | Deletion blocked — other entities still reference this resource. | | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. | | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient account balance. | | `AccessDenied` | 403 | Authenticated but lacking the permission required for this operation. | | `RouteNotFound` | 404 | The request URL path is not a known route. | | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this otherwise-known path. | | `UndonedOrderExist` | 409 | An outstanding billing order blocks this new one. Wait and retry. | | `RequestLocked` | 423 | Operation temporarily locked due to repeated failures. | | `EntityTooLarge` | 413 | Request body exceeds the configured max size. | | `RequestTooFrequently` | 429 | Rate limit hit — API-global, per-account, or per-integration. | | `RequestVerifyRequired` | 428 | Second-factor verification required but not supplied. | | `DangerousOperation` | 428 | High-risk operation requires MFA verification. | | `InternalError` | 500 | Unhandled server-side error. Include `request_id` in the bug report. | | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try again later. | enum: - OK - InvalidParameter - BadRequest - InvalidContentType - ResourceNotFound - NoLicense - ReferenceExist - Unauthorized - BalanceNotEnough - AccessDenied - RouteNotFound - MethodNotAllowed - UndonedOrderExist - RequestLocked - EntityTooLarge - RequestTooFrequently - RequestVerifyRequired - DangerousOperation - InternalError - ServiceUnavailable x-enumDescriptions: OK: Reserved — not returned on real errors. InvalidParameter: A required parameter is missing or failed validation. BadRequest: Generic 400 used when no more specific code fits. InvalidContentType: The `Content-Type` header is not `application/json`. ResourceNotFound: >- The referenced resource does not exist. Note: returned as HTTP 400, not 404 (historical choice). NoLicense: The feature is license-gated and no active license was found. ReferenceExist: Deletion blocked — other entities still reference this resource. Unauthorized: '`app_key` is missing, invalid, or expired.' BalanceNotEnough: Billing-gated operation with insufficient account balance. AccessDenied: Authenticated but lacking the permission required for this operation. RouteNotFound: The request URL path is not a known route. MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path. UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry. RequestLocked: Operation temporarily locked due to repeated failures. EntityTooLarge: Request body exceeds the configured max size. RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration. RequestVerifyRequired: Second-factor verification required but not supplied. DangerousOperation: High-risk operation requires MFA verification. InternalError: Unhandled server-side error. Include `request_id` in the bug report. ServiceUnavailable: A backend dependency is unavailable. Try again later. example: InvalidParameter FilterCondition: type: object required: - key - oper - vals properties: key: type: string description: >- Field name to filter on. Use plain names for built-in alert fields (e.g. `alert_severity`, `alert_key`, `check`, `resource`, `service`, `cluster`) or the `labels.` prefix for custom alert labels (e.g. `labels.env`, `labels.region`). oper: type: string enum: - IN - NOTIN description: >- Filter operator. `IN` — value must match one of `vals`; `NOTIN` — value must not match any of `vals`. Supports regex patterns wrapped in `/pattern/`. vals: type: array items: type: string description: >- List of values to match against. Each entry is a plain string or a `/regex/` pattern. responses: BadRequest: description: Invalid request — usually a missing or malformed parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InvalidParameter message: The specified parameter is not valid. Unauthorized: description: Missing or invalid app_key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingAppKey: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: Unauthorized message: You are unauthorized. TooManyRequests: description: >- Rate limit hit. Either the global API limit, a per-account limit, or a per-integration limit. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: RequestTooFrequently message: Request too frequently. ServerError: description: Unexpected server-side error. Include the request_id when reporting. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internal: value: request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4 error: code: InternalError message: >- We encountered an internal error, and it has been reported. Please try again later. securitySchemes: AppKeyAuth: type: apiKey in: query name: app_key description: >- App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account. ````