> ## Documentation Index > Fetch the complete documentation index at: https://docs.coralogix.com/llms.txt > Use this file to discover all available pages before exploring further. # Get an alert scheduler rule > Returns the details of the specified alert suppression rule. ## OpenAPI ````yaml openapi_v5.yaml get /alerts/suppression-rules/v1/{alert_scheduler_rule_id} openapi: 3.0.0 info: title: '' version: 1.0.0 servers: - url: https://api.coralogix.com/mgmt/openapi/5 - url: https://api.eu2.coralogix.com/mgmt/openapi/5 - url: https://api.coralogix.us/mgmt/openapi/5 - url: https://api.cx498.coralogix.com/mgmt/openapi/5 - url: https://api.coralogix.in/mgmt/openapi/5 - url: https://api.coralogixsg.com/mgmt/openapi/5 - url: https://api.ap3.coralogix.com/mgmt/openapi/5 security: - apiKeyAuth: [] tags: - name: AI Applications Service description: Manage the catalog of AI applications discovered from spans. externalDocs: url: '' - name: AI Evaluations Service description: >- Manage AI evaluations and the custom evaluation catalog for AI applications. externalDocs: url: '' - name: API Keys Admin Service description: Administrative operations for API Keys management. externalDocs: url: '' - name: API Keys Service description: Manage your API Keys. externalDocs: url: '' - name: Actions Service description: View and manage your Actions. externalDocs: url: '' - name: Alert Scheduler Rule service description: Manage your alert scheduler rules. externalDocs: url: '' - name: Alert definitions service description: >- View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert. externalDocs: description: Learn more about alerts in our documentation url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ - name: Alert events service description: >- Get information regarding your alert events - instances of alerts being triggered. externalDocs: description: Learn more about alert events and incidents in our documentation. url: https://coralogix.com/docs/user-guides/alerting/incidents/ - name: Case Events service description: Manage case events, comments, and external thread synchronization. externalDocs: url: '' - name: Case Settings service description: Manage case settings team configurations. externalDocs: url: '' - name: Cases notification service description: Track notification adjacent data for cases. externalDocs: url: '' - name: Cases service description: >- Manage cases throughout their lifecycle. Create, view, assign, acknowledge, unacknowledge, resolve, and close cases to streamline investigations and follow-ups. externalDocs: description: Learn more about Cases in our documentation url: https://coralogix.com/docs/user-guides/cases/ - name: Connector Schema service description: Retrieve connector schemas for notification center integrations externalDocs: description: Learn more about connectors in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ - name: Connectors service description: >- View and manage your connectors - integration instances for notification destinations externalDocs: description: Lean more about connectors in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/ - name: Contextual data integration service description: Query for contextual data integration information. externalDocs: url: '' - name: Custom Enrichments Service description: Manage your enrichments. externalDocs: url: '' - name: Dashboard folders service description: Manage your dashboard folders. externalDocs: url: '' - name: Dashboard service description: Get information about the Coralogix Dashboard catalog. externalDocs: url: '' - name: Data Usage Query service description: >- Query billable data usage through the public Coralogix API using daily or hourly bucketed aggregations over supported labels. externalDocs: url: '' - name: Data Usage Service description: A service to manage data usage metrics. externalDocs: url: '' - name: Enrichments Service description: Manage your enrichments. externalDocs: url: '' - name: Entities service description: Query information about registered entities in the notification center externalDocs: description: Lean more about the notification center in our documentation url: https://coralogix.com/docs/user-guides/notification-center/introduction/ - name: Events Service description: A service for querying events. externalDocs: description: Learn more about alerts in our documentation url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/ - name: Events2Metrics Service description: Manage your events2metrics. externalDocs: url: '' - name: Extension deployment service description: A service that enables querying for extension deployment information. externalDocs: description: Find out more about extensions in our documentation. url: https://coralogix.com/docs/integrations/extensions/ - name: Extension service description: A service that enables querying for extension information. externalDocs: description: Learn more about extensions in our documentation. url: https://coralogix.com/docs/integrations/extensions/ - name: Folders for views service description: Create and manage view folders. externalDocs: url: '' - name: Global routers service description: >- View and manage your global routers - entities that direct notifications to configured destinations based on conditions externalDocs: description: Lean more about global routers in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/routing/introduction/ - name: IP access service description: >- IP access service provides the API for managing company IP access settings. externalDocs: url: '' - name: Incidents service description: >- Handle all operations related to incident management within Coralogix. Identify, manage, and resolve incidents efficiently through automated workflows and team collaboration. externalDocs: description: Find out more about incident management in our documentation url: https://coralogix.com/docs/user-guides/alerting/incidents/ - name: Integration service description: A service that enables querying for integration information. externalDocs: description: Find out more about integrations in our documentation. url: https://coralogix.com/docs/integrations/getting-started/ - name: Metrics Data Archive Service description: View and manage your storage targets for metrics. externalDocs: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - name: Notifications testing service description: >- Test your notification center configurations including connectors, presets, and templates externalDocs: description: Lean more about the notification center in our documentation url: https://coralogix.com/docs/user-guides/notification-center/introduction/ - name: Outgoing webhooks service externalDocs: description: Find out more about outbound webhooks in our documentation. url: >- https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/ - name: Policies Service description: View and manage your TCO policies externalDocs: url: '' - name: Presets service description: >- View and manage your presets - pre-configured templates for notification content rendering externalDocs: description: Lean more about presets in our documentation url: >- https://coralogix.com/docs/user-guides/notification-center/presets/introduction/ - name: Quota Allocation Rule Set service description: Manage quota allocation rules for different entity types. externalDocs: url: '' - name: Recording Rules Service description: A service to manage recording rules. externalDocs: url: '' - name: Retentions Service description: View and manage retentions externalDocs: url: '' - name: Role Management Service description: Service for managing system and custom roles. externalDocs: url: '' - name: Rule Groups Service description: A service to manage rule groups. externalDocs: url: '' - name: SAML Configuration Service description: Manage your SAML configuration externalDocs: url: '' - name: Scopes Service description: A service to manage scopes externalDocs: url: '' - name: Slos Service description: A service for managing Service Level Objectives (SLOs). externalDocs: url: '' - name: Target Service description: View and manage your storage targets for logs. externalDocs: description: Find out more about archives url: >- https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/ - name: Team Groups Management Service description: Manage Team Groups. externalDocs: url: '' - name: Users Management Service description: >- Manage team members (users) including creation, updates, search, and status management. externalDocs: url: '' - name: Views service description: Create and manage views. externalDocs: url: '' paths: /alerts/suppression-rules/v1/{alert_scheduler_rule_id}: get: tags: - Alert Scheduler Rule service summary: Get an alert scheduler rule description: Returns the details of the specified alert suppression rule. operationId: AlertSchedulerRuleService_GetAlertSchedulerRule parameters: - description: The unique identifier of the alert scheduler (suppression) rule. in: path name: alert_scheduler_rule_id required: true schema: minLength: 0 type: string description: The unique identifier of the alert scheduler (suppression) rule. responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetAlertSchedulerRuleResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/Error' description: Unauthorized request '500': content: application/json: schema: $ref: '#/components/schemas/Error' description: Internal server error externalDocs: url: '' components: schemas: GetAlertSchedulerRuleResponse: title: Get alert scheduler rule response data structure required: - alertSchedulerRule type: object properties: alertSchedulerRule: $ref: '#/components/schemas/AlertSchedulerRule' description: This is a response sent to get an alert scheduler rule externalDocs: description: Find out more about alert scheduler rules in our documentation. url: >- https://coralogix.com/docs/developer-portal/apis/data-management/alert-suppression-rules-api/ Error: type: object properties: code: maximum: 599 minimum: 100 type: integer description: HTTP status code of the error (for example 400, 404, 500). format: int32 message: maxLength: 4096 minLength: 0 pattern: ^[\s\S]*$ type: string description: Human-readable description of the error. description: Standard error response body returned for a failed request. AlertSchedulerRule: type: object properties: createdAt: minLength: 0 type: string description: Creation timestamp. description: minLength: 0 type: string description: Human-readable description. enabled: type: boolean description: Whether this resource is enabled. filter: $ref: '#/components/schemas/alert_scheduler_rule_protobuf.v1.Filter' id: minLength: 0 type: string description: Unique identifier. metaLabels: minItems: 0 type: array items: $ref: '#/components/schemas/meta_labels_protobuf.v1.MetaLabel' description: Metadata labels. name: minLength: 0 type: string description: Display name. schedule: $ref: '#/components/schemas/Schedule' uniqueIdentifier: minLength: 0 type: string description: Unique identifier. updatedAt: minLength: 0 type: string description: Last-updated timestamp. description: Alert scheduler rule. externalDocs: url: '' alert_scheduler_rule_protobuf.v1.Filter: type: object oneOf: - required: - alertMetaLabels type: object - required: - alertUniqueIds type: object - type: object not: anyOf: - required: - alertMetaLabels type: object - required: - alertUniqueIds type: object properties: alertMetaLabels: $ref: '#/components/schemas/MetaLabels' alertUniqueIds: $ref: '#/components/schemas/AlertUniqueIds' whatExpression: minLength: 0 type: string description: Dataprime expression that filters the alerts by group-by values. description: Alert scheduler rule protobuf.v1.filter. externalDocs: url: '' meta_labels_protobuf.v1.MetaLabel: type: object properties: id: minLength: 0 type: string description: Unique identifier. key: minLength: 0 type: string description: The key. value: minLength: 0 type: string description: The value. description: Meta label. externalDocs: url: '' Schedule: type: object oneOf: - required: - oneTime type: object - required: - recurring type: object - type: object not: anyOf: - required: - oneTime type: object - required: - recurring type: object properties: oneTime: $ref: '#/components/schemas/OneTime' recurring: $ref: '#/components/schemas/Recurring' scheduleOperation: $ref: '#/components/schemas/ScheduleOperation' description: Schedule. externalDocs: url: '' MetaLabels: type: object properties: value: minItems: 0 type: array items: $ref: '#/components/schemas/meta_labels_protobuf.v1.MetaLabel' description: The value. description: Meta labels. externalDocs: url: '' AlertUniqueIds: type: object properties: value: minItems: 0 type: array items: minLength: 0 type: string description: The value. description: The value. description: Alert unique ids. externalDocs: url: '' OneTime: type: object properties: timeframe: $ref: '#/components/schemas/Timeframe' description: One time. externalDocs: url: '' Recurring: type: object oneOf: - required: - alwaysActive type: object - required: - schedule type: object - type: object not: anyOf: - required: - alwaysActive type: object - required: - schedule type: object properties: alwaysActive: $ref: '#/components/schemas/Always' schedule: $ref: '#/components/schemas/Recurring.Dynamic' description: >- Recurring schedule that activates the alert scheduler rule on a repeating cadence. externalDocs: url: '' ScheduleOperation: enum: - SCHEDULE_OPERATION_UNSPECIFIED - SCHEDULE_OPERATION_MUTE - SCHEDULE_OPERATION_ACTIVATE type: string description: Schedule operation. Timeframe: type: object oneOf: - required: - endTime type: object - required: - duration type: object - type: object not: anyOf: - required: - endTime type: object - required: - duration type: object properties: duration: $ref: '#/components/schemas/v1.Duration' endTime: minLength: 0 type: string description: End time. startTime: minLength: 0 type: string description: Start time. timezone: minLength: 0 type: string description: Timezone. description: Timeframe. externalDocs: url: '' Always: type: object additionalProperties: false description: Always. externalDocs: url: '' Recurring.Dynamic: type: object oneOf: - required: - daily type: object - required: - weekly type: object - required: - monthly type: object - type: object not: anyOf: - required: - daily type: object - required: - weekly type: object - required: - monthly type: object properties: daily: $ref: '#/components/schemas/Daily' monthly: $ref: '#/components/schemas/Monthly' repeatEvery: type: integer description: >- Interval multiplier controlling how often the rule recurs (e.g., every N days, weeks, or months). format: int32 terminationDate: minLength: 0 type: string description: ISO 8601 date after which the recurring rule stops being applied. timeframe: $ref: '#/components/schemas/Timeframe' weekly: $ref: '#/components/schemas/Weekly' description: Dynamic. externalDocs: url: '' v1.Duration: type: object properties: forOver: type: integer description: The for over. format: int32 frequency: $ref: '#/components/schemas/DurationFrequency' description: Duration. externalDocs: url: '' Daily: type: object additionalProperties: false description: Daily. externalDocs: url: '' Monthly: type: object properties: daysOfMonth: minItems: 0 type: array items: type: integer description: The days of month. format: int32 description: The days of month. description: Monthly. externalDocs: url: '' Weekly: type: object properties: daysOfWeek: minItems: 0 type: array items: type: integer description: The days of week. format: int32 description: The days of week. description: Weekly. externalDocs: url: '' DurationFrequency: enum: - DURATION_FREQUENCY_UNSPECIFIED - DURATION_FREQUENCY_MINUTE - DURATION_FREQUENCY_HOUR - DURATION_FREQUENCY_DAY type: string description: Duration frequency. securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: API key authentication ````