> ## Documentation Index > Fetch the complete documentation index at: https://coralogix-193a2008-facade-sync-4ab5cdd.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Download alerts > Download alert definitions in base64-encoded byte format. When ids are provided, only those alert definitions are downloaded; otherwise all accessible alert definitions are downloaded. Requires the following permissions: - `alerts:ReadConfig` ## OpenAPI ````yaml openapi_v5.yaml get /alerts/alerts/v3/all/download 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: Manage your dashboards. 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: 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: Teams Service description: >- Deprecated. Read and manage the teams in an organization and the daily quota assigned to each of them. 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/alerts/v3/all/download: get: tags: - Alert definitions service summary: Download alerts description: >- Download alert definitions in base64-encoded byte format. When ids are provided, only those alert definitions are downloaded; otherwise all accessible alert definitions are downloaded. Requires the following permissions: - `alerts:ReadConfig` operationId: AlertDefsService_DownloadAlerts parameters: - description: >- Optional list of alert definition IDs to download. When empty, all accessible alert definitions are downloaded. IDs that are not found or not accessible are omitted from the download and reported in the response notFoundIds (no error is returned for them). in: query name: ids required: false schema: description: >- Optional list of alert definition IDs to download. When empty, all accessible alert definitions are downloaded. IDs that are not found or not accessible are omitted from the download and reported in the response notFoundIds (no error is returned for them). example: - 123e4567-e89b-12d3-a456-426614174000 items: description: >- Optional list of alert definition IDs to download. When empty, all accessible alert definitions are downloaded. IDs that are not found or not accessible are omitted from the download and reported in the response notFoundIds (no error is returned for them). maxLength: 36 minLength: 0 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string maxItems: 1000 minItems: 0 type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/DownloadAlertsResponse' 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: DownloadAlertsResponse: title: Download alerts response type: object properties: content: minLength: 0 type: string description: Base64-encoded binary data of the alert definitions format: byte example: SGVsbG8gV29ybGQ= notFoundIds: maxItems: 1000 minItems: 0 type: array items: maxLength: 36 minLength: 0 pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ type: string description: >- Requested alert definition IDs that were not included in the download because they were not found or are not accessible. Populated on the first streamed message. description: >- Requested alert definition IDs that were not included in the download because they were not found or are not accessible. Populated on the first streamed message. example: - 123e4567-e89b-12d3-a456-426614174000 description: A response containing the downloaded alert data externalDocs: url: '' 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. securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: API key authentication ````