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

# Create Rule Group

> No description available



## OpenAPI

````yaml openapi_v3.yaml post /parsing-rules/rule-groups/v1
openapi: 3.0.0
info:
  title: ''
  version: 1.0.0
servers:
  - url: https://api.coralogix.com/mgmt/openapi/3
  - url: https://api.eu2.coralogix.com/mgmt/openapi/3
  - url: https://api.coralogix.us/mgmt/openapi/3
  - url: https://api.cx498.coralogix.com/mgmt/openapi/3
  - url: https://api.coralogix.in/mgmt/openapi/3
  - url: https://api.coralogixsg.com/mgmt/openapi/3
  - url: https://api.ap3.coralogix.com/mgmt/openapi/3
security:
  - apiKeyAuth: []
tags:
  - 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: 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: 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: Cases service
    description: >-
      Manage cases throughout their lifecycle. Create, view, assign,
      acknowledge, 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: SAML Configuration Service
    description: Manage your SAML configuration
    externalDocs:
      url: ''
  - name: Events2Metrics Service
    description: Manage your events2metrics.
    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: 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: API Keys Service
    description: Manage your API Keys.
    externalDocs:
      url: ''
  - 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: Scopes Service
    description: A service to manage scopes
    externalDocs:
      url: ''
  - name: IP access service
    description: >-
      IP access service provides the API for managing company IP access
      settings.
    externalDocs:
      url: ''
  - name: Dashboard service
    description: Get information about the Coralogix Dashboard catalog.
    externalDocs:
      url: ''
  - 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: Team Permissions Management Service
    description: Manage Team Groups.
    externalDocs:
      url: ''
  - 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: Extension testing service
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Data Usage Service
    description: A service to manage data usage metrics.
    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: Contextual data integration service
    description: Query for contextual data integration information.
    externalDocs:
      url: ''
  - name: Custom Enrichments Service
    description: Manage your enrichments.
    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: Recording Rules Service
    description: A service to manage recording rules.
    externalDocs:
      url: ''
  - name: Folders for views service
    description: Create and manage view folders.
    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: Retentions Service
    description: View and manage retentions
    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: Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Role Management Service
    description: Service for managing system and custom roles.
    externalDocs:
      url: ''
  - 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: Rule Groups Service
    description: A service to manage rule groups.
    externalDocs:
      url: ''
  - name: Policies Service
    description: View and manage your TCO policies
    externalDocs:
      url: ''
  - name: Alert Scheduler Rule service
    description: Manage your alert scheduler rules.
    externalDocs:
      url: ''
  - name: Dashboard folders service
    description: Manage your dashboard folders.
    externalDocs:
      url: ''
  - name: Actions Service
    description: A service for managing actions.
    externalDocs:
      url: ''
  - name: Slos Service
    description: A service for managing Service Level Objectives (SLOs).
    externalDocs:
      url: ''
  - name: Views service
    description: Create and manage views.
    externalDocs:
      url: ''
  - 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: SLO Service
    description: Manage your SLOs.
    externalDocs:
      url: ''
paths:
  /parsing-rules/rule-groups/v1:
    post:
      tags:
        - Rule Groups Service
      summary: Create Rule Group
      description: No description available
      operationId: RuleGroupsService_CreateRuleGroup
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                creator:
                  type: string
                description:
                  type: string
                enabled:
                  type: boolean
                hidden:
                  type: boolean
                name:
                  type: string
                order:
                  type: integer
                  format: int64
                ruleMatchers:
                  type: array
                  items:
                    $ref: '#/components/schemas/RuleMatcher'
                ruleSubgroups:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/CreateRuleGroupRequest.CreateRuleSubgroup
                teamId:
                  $ref: '#/components/schemas/rules.v1.TeamId'
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRuleGroupResponse'
          description: ''
        '400':
          content:
            application/json: {}
          description: Bad Request
        '401':
          content:
            application/json: {}
          description: Unauthorized request
        '500':
          content:
            application/json: {}
          description: Internal server error
      externalDocs:
        url: ''
components:
  schemas:
    RuleMatcher:
      oneOf:
        - $ref: '#/components/schemas/RuleMatcherSeverity'
        - $ref: '#/components/schemas/RuleMatcherApplicationName'
        - $ref: '#/components/schemas/RuleMatcherSubsystemName'
    CreateRuleGroupRequest.CreateRuleSubgroup:
      type: object
      properties:
        enabled:
          type: boolean
        order:
          type: integer
          format: int64
        rules:
          type: array
          items:
            $ref: >-
              #/components/schemas/CreateRuleGroupRequest.CreateRuleSubgroup.CreateRule
    rules.v1.TeamId:
      type: object
      properties:
        id:
          type: integer
          format: int64
    CreateRuleGroupResponse:
      type: object
      properties:
        ruleGroup:
          $ref: '#/components/schemas/RuleGroup'
    RuleMatcherSeverity:
      type: object
      properties:
        severity:
          $ref: '#/components/schemas/SeverityConstraint'
      additionalProperties: false
    RuleMatcherApplicationName:
      type: object
      properties:
        applicationName:
          $ref: '#/components/schemas/ApplicationNameConstraint'
      additionalProperties: false
    RuleMatcherSubsystemName:
      type: object
      properties:
        subsystemName:
          $ref: '#/components/schemas/SubsystemNameConstraint'
      additionalProperties: false
    CreateRuleGroupRequest.CreateRuleSubgroup.CreateRule:
      type: object
      properties:
        description:
          type: string
        enabled:
          type: boolean
        name:
          type: string
        order:
          type: integer
          format: int64
        parameters:
          $ref: '#/components/schemas/RuleParameters'
        sourceField:
          type: string
    RuleGroup:
      type: object
      properties:
        creator:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        hidden:
          type: boolean
        id:
          type: string
        name:
          type: string
        order:
          type: integer
          format: int64
        ruleMatchers:
          type: array
          items:
            $ref: '#/components/schemas/RuleMatcher'
        ruleSubgroups:
          type: array
          items:
            $ref: '#/components/schemas/RuleSubgroup'
    SeverityConstraint:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/Value'
    ApplicationNameConstraint:
      type: object
      properties:
        value:
          type: string
    SubsystemNameConstraint:
      type: object
      properties:
        value:
          type: string
    RuleParameters:
      oneOf:
        - $ref: '#/components/schemas/RuleParametersJsonExtractParameters'
        - $ref: '#/components/schemas/RuleParametersReplaceParameters'
        - $ref: '#/components/schemas/RuleParametersParseParameters'
        - $ref: '#/components/schemas/RuleParametersExtractTimestampParameters'
        - $ref: '#/components/schemas/RuleParametersRemoveFieldsParameters'
        - $ref: '#/components/schemas/RuleParametersJsonStringifyParameters'
        - $ref: '#/components/schemas/RuleParametersJsonParseParameters'
        - $ref: '#/components/schemas/RuleParametersExtractParameters'
        - $ref: '#/components/schemas/RuleParametersAllowParameters'
        - $ref: '#/components/schemas/RuleParametersBlockParameters'
    RuleSubgroup:
      type: object
      properties:
        enabled:
          type: boolean
        id:
          type: string
        order:
          type: integer
          format: int64
        rules:
          type: array
          items:
            $ref: '#/components/schemas/rules.v1.Rule'
    Value:
      enum:
        - VALUE_DEBUG_OR_UNSPECIFIED
        - VALUE_VERBOSE
        - VALUE_INFO
        - VALUE_WARNING
        - VALUE_ERROR
        - VALUE_CRITICAL
      type: string
    RuleParametersJsonExtractParameters:
      type: object
      properties:
        jsonExtractParameters:
          $ref: '#/components/schemas/JsonExtractParameters'
      additionalProperties: false
    RuleParametersReplaceParameters:
      type: object
      properties:
        replaceParameters:
          $ref: '#/components/schemas/ReplaceParameters'
      additionalProperties: false
    RuleParametersParseParameters:
      type: object
      properties:
        parseParameters:
          $ref: '#/components/schemas/ParseParameters'
      additionalProperties: false
    RuleParametersExtractTimestampParameters:
      type: object
      properties:
        extractTimestampParameters:
          $ref: '#/components/schemas/ExtractTimestampParameters'
      additionalProperties: false
    RuleParametersRemoveFieldsParameters:
      type: object
      properties:
        removeFieldsParameters:
          $ref: '#/components/schemas/RemoveFieldsParameters'
      additionalProperties: false
    RuleParametersJsonStringifyParameters:
      type: object
      properties:
        jsonStringifyParameters:
          $ref: '#/components/schemas/JsonStringifyParameters'
      additionalProperties: false
    RuleParametersJsonParseParameters:
      type: object
      properties:
        jsonParseParameters:
          $ref: '#/components/schemas/JsonParseParameters'
      additionalProperties: false
    RuleParametersExtractParameters:
      type: object
      properties:
        extractParameters:
          $ref: '#/components/schemas/ExtractParameters'
      additionalProperties: false
    RuleParametersAllowParameters:
      type: object
      properties:
        allowParameters:
          $ref: '#/components/schemas/AllowParameters'
      additionalProperties: false
    RuleParametersBlockParameters:
      type: object
      properties:
        blockParameters:
          $ref: '#/components/schemas/BlockParameters'
      additionalProperties: false
    rules.v1.Rule:
      type: object
      properties:
        description:
          type: string
        enabled:
          type: boolean
        id:
          type: string
        name:
          type: string
        order:
          type: integer
          format: int64
        parameters:
          $ref: '#/components/schemas/RuleParameters'
        sourceField:
          type: string
    JsonExtractParameters:
      type: object
      properties:
        destinationFieldText:
          type: string
        destinationFieldType:
          $ref: '#/components/schemas/DestinationField'
        rule:
          type: string
    ReplaceParameters:
      type: object
      properties:
        destinationField:
          type: string
        replaceNewVal:
          type: string
        rule:
          type: string
    ParseParameters:
      type: object
      properties:
        destinationField:
          type: string
        rule:
          type: string
    ExtractTimestampParameters:
      type: object
      properties:
        format:
          type: string
        standard:
          $ref: '#/components/schemas/FormatStandard'
    RemoveFieldsParameters:
      type: object
      properties:
        fields:
          type: array
          items:
            type: string
    JsonStringifyParameters:
      type: object
      properties:
        deleteSource:
          type: boolean
        destinationField:
          type: string
    JsonParseParameters:
      type: object
      properties:
        deleteSource:
          type: boolean
        destinationField:
          type: string
        escapedValue:
          type: boolean
        overrideDest:
          type: boolean
    ExtractParameters:
      type: object
      properties:
        rule:
          type: string
    AllowParameters:
      type: object
      properties:
        keepBlockedLogs:
          type: boolean
        rule:
          type: string
    BlockParameters:
      type: object
      properties:
        keepBlockedLogs:
          type: boolean
        rule:
          type: string
    DestinationField:
      enum:
        - DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED
        - DESTINATION_FIELD_CLASSNAME
        - DESTINATION_FIELD_METHODNAME
        - DESTINATION_FIELD_THREADID
        - DESTINATION_FIELD_SEVERITY
        - DESTINATION_FIELD_TEXT
      type: string
    FormatStandard:
      enum:
        - FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED
        - FORMAT_STANDARD_JAVASDF
        - FORMAT_STANDARD_GOLANG
        - FORMAT_STANDARD_SECONDSTS
        - FORMAT_STANDARD_MILLITS
        - FORMAT_STANDARD_MICROTS
        - FORMAT_STANDARD_NANOTS
      type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````