> ## 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.

# Atomic Overwrite for CustomEnrichments only

> Updates enrichment rules.



## OpenAPI

````yaml openapi_v5.yaml put /enrichment-rules/enrichment-rules/v1
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:
  /enrichment-rules/enrichment-rules/v1:
    put:
      tags:
        - Enrichments Service
      summary: Atomic Overwrite for CustomEnrichments only
      description: Updates enrichment rules.
      operationId: EnrichmentService_AtomicOverwriteEnrichments
      requestBody:
        content:
          application/json:
            schema:
              description: Request to atomically update enrichment rules.
              properties:
                enrichmentFields:
                  minItems: 0
                  type: array
                  items:
                    $ref: '#/components/schemas/EnrichmentFieldDefinition'
                  description: 'Deprecated: enrichment field definitions.'
                enrichmentType:
                  $ref: '#/components/schemas/EnrichmentType'
                requestEnrichments:
                  minItems: 0
                  type: array
                  items:
                    $ref: '#/components/schemas/EnrichmentRequestModel'
                  description: >-
                    List of enrichment rules to atomically replace existing
                    rules.
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtomicOverwriteEnrichmentsResponse'
          description: ''
      externalDocs:
        url: ''
components:
  schemas:
    EnrichmentFieldDefinition:
      type: object
      properties:
        enrichedFieldName:
          minLength: 0
          type: string
          description: The enriched field name.
        fieldName:
          minLength: 0
          type: string
          description: The field name.
        selectedColumns:
          minItems: 0
          type: array
          items:
            minLength: 0
            type: string
            description: The selected columns.
          description: The selected columns.
        targets:
          maxItems: 10
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/DatasetTarget'
          description: The targets for the enrichment
    EnrichmentType:
      type: object
      oneOf:
        - required:
            - geoIp
          type: object
        - required:
            - suspiciousIp
          type: object
        - required:
            - aws
          type: object
        - required:
            - customEnrichment
          type: object
        - type: object
          not:
            anyOf:
              - required:
                  - geoIp
                type: object
              - required:
                  - suspiciousIp
                type: object
              - required:
                  - aws
                type: object
              - required:
                  - customEnrichment
                type: object
      properties:
        aws:
          $ref: '#/components/schemas/AwsType'
        customEnrichment:
          $ref: '#/components/schemas/CustomEnrichmentType'
        geoIp:
          $ref: '#/components/schemas/GeoIpType'
        suspiciousIp:
          $ref: '#/components/schemas/SuspiciousIpType'
      description: Enrichment type.
      externalDocs:
        url: ''
    EnrichmentRequestModel:
      title: Enrichment Prototype
      required:
        - fieldName
        - enrichmentType
      type: object
      properties:
        enrichedFieldName:
          minLength: 0
          type: string
          description: The enriched field name.
        enrichmentType:
          $ref: '#/components/schemas/EnrichmentType'
        fieldName:
          minLength: 0
          type: string
          description: The field name.
          example: sourceIPs
        selectedColumns:
          minItems: 0
          type: array
          items:
            minLength: 0
            type: string
            description: The selected columns.
          description: The selected columns.
        targets:
          maxItems: 10
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/DatasetTarget'
          description: The targets for the enrichment
      description: The enrichment request model
      externalDocs:
        description: Find out more about enrichments
        url: >-
          https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/
    AtomicOverwriteEnrichmentsResponse:
      type: object
      properties:
        enrichments:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/Enrichment'
          description: List of enrichments.
      description: Response returned after atomically updating enrichment rules.
      externalDocs:
        url: ''
    DatasetTarget:
      title: Dataset Target
      type: object
      properties:
        dataset:
          maxLength: 100
          minLength: 1
          pattern: ^[a-zA-Z0-9_][a-zA-Z0-9_./-]*$
          type: string
          description: The dataset name in which the enrichment will be applied.
          example: dataset1
      description: >-
        This data structure represents a target for enrichments. It defines a
        dataset in which the enrichment will be applied to.
      externalDocs:
        url: ''
    AwsType:
      type: object
      properties:
        resourceType:
          minLength: 0
          type: string
          description: The resource type.
          example: ec2
      description: Aws type.
      externalDocs:
        url: ''
    CustomEnrichmentType:
      type: object
      properties:
        id:
          minimum: 0
          type: integer
          description: Unique identifier.
          format: int64
          example: 1
      description: Custom enrichment type.
      externalDocs:
        url: ''
    GeoIpType:
      type: object
      properties:
        withAsn:
          type: boolean
          description: The with asn.
      description: Geo ip type.
      externalDocs:
        url: ''
    SuspiciousIpType:
      type: object
      additionalProperties: false
      description: Suspicious ip type.
      externalDocs:
        url: ''
    Enrichment:
      title: Enrichment
      required:
        - id
        - fieldName
        - enrichmentType
      type: object
      properties:
        enrichedFieldName:
          minLength: 0
          type: string
          description: The enriched field name.
          example: '1'
        enrichmentType:
          $ref: '#/components/schemas/EnrichmentType'
        fieldName:
          minLength: 0
          type: string
          description: The field name.
          example: '1'
        id:
          minimum: 0
          type: integer
          description: Unique identifier.
          format: int64
          example: 1
        selectedColumns:
          minItems: 0
          type: array
          items:
            minLength: 0
            type: string
            description: The selected columns.
          description: The selected columns.
          example:
            - city
            - population
        targets:
          maxItems: 10
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/DatasetTarget'
          description: The targets for the enrichment
      description: This data structure represents an enrichment
      externalDocs:
        description: Find out more about enrichments
        url: >-
          https://coralogix.com/docs/user-guides/data-transformation/enrichments/custom-enrichment/
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````