> ## 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 Rule Group

> Returns the details of the specified parsing rule group.



## OpenAPI

````yaml openapi_v5.yaml get /parsing-rules/rule-groups/v1/{group_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:
  /parsing-rules/rule-groups/v1/{group_id}:
    get:
      tags:
        - Rule Groups Service
      summary: Get Rule Group
      description: Returns the details of the specified parsing rule group.
      operationId: RuleGroupsService_GetRuleGroup
      parameters:
        - description: The unique identifier of the parsing rule group to retrieve.
          in: path
          name: group_id
          required: true
          schema:
            minLength: 0
            type: string
            description: The unique identifier of the parsing rule group to retrieve.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRuleGroupResponse'
          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:
    GetRuleGroupResponse:
      type: object
      properties:
        ruleGroup:
          $ref: '#/components/schemas/RuleGroup'
      description: Response containing the details of a parsing rule group.
      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.
    RuleGroup:
      type: object
      properties:
        creator:
          minLength: 0
          type: string
          description: Creator.
        description:
          minLength: 0
          type: string
          description: Human-readable description.
        enabled:
          type: boolean
          description: Whether this resource is enabled.
        hidden:
          type: boolean
          description: The hidden.
        id:
          minLength: 0
          type: string
          description: Unique identifier.
        name:
          minLength: 0
          type: string
          description: Display name.
        order:
          minimum: 0
          type: integer
          description: Sort order.
          format: int64
        ruleMatchers:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/RuleMatcher'
          description: The rule matchers.
        ruleSubgroups:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/RuleSubgroup'
          description: The rule subgroups.
      description: Rule group.
      externalDocs:
        url: ''
    RuleMatcher:
      type: object
      oneOf:
        - required:
            - applicationName
          type: object
        - required:
            - subsystemName
          type: object
        - required:
            - severity
          type: object
        - type: object
          not:
            anyOf:
              - required:
                  - applicationName
                type: object
              - required:
                  - subsystemName
                type: object
              - required:
                  - severity
                type: object
      properties:
        applicationName:
          $ref: '#/components/schemas/ApplicationNameConstraint'
        severity:
          $ref: '#/components/schemas/SeverityConstraint'
        subsystemName:
          $ref: '#/components/schemas/SubsystemNameConstraint'
    RuleSubgroup:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether this resource is enabled.
        id:
          minLength: 0
          type: string
          description: Unique identifier.
        order:
          minimum: 0
          type: integer
          description: Sort order.
          format: int64
        rules:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/rules.v1.Rule'
          description: List of rules.
    ApplicationNameConstraint:
      type: object
      properties:
        value:
          minLength: 0
          type: string
          description: The value.
      description: Application name constraint.
      externalDocs:
        url: ''
    SeverityConstraint:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/Value'
      description: Severity constraint.
      externalDocs:
        url: ''
    SubsystemNameConstraint:
      type: object
      properties:
        value:
          minLength: 0
          type: string
          description: The value.
      description: Subsystem name constraint.
      externalDocs:
        url: ''
    rules.v1.Rule:
      type: object
      properties:
        description:
          minLength: 0
          type: string
          description: Human-readable description.
        enabled:
          type: boolean
          description: Whether this resource is enabled.
        id:
          minLength: 0
          type: string
          description: Unique identifier.
        name:
          minLength: 0
          type: string
          description: Display name.
        order:
          minimum: 0
          type: integer
          description: Sort order.
          format: int64
        parameters:
          $ref: '#/components/schemas/RuleParameters'
        sourceField:
          minLength: 0
          type: string
          description: The source field.
    Value:
      enum:
        - VALUE_DEBUG_OR_UNSPECIFIED
        - VALUE_VERBOSE
        - VALUE_INFO
        - VALUE_WARNING
        - VALUE_ERROR
        - VALUE_CRITICAL
      type: string
      description: Value.
    RuleParameters:
      type: object
      oneOf:
        - required:
            - extractParameters
          type: object
        - required:
            - jsonExtractParameters
          type: object
        - required:
            - replaceParameters
          type: object
        - required:
            - parseParameters
          type: object
        - required:
            - allowParameters
          type: object
        - required:
            - blockParameters
          type: object
        - required:
            - extractTimestampParameters
          type: object
        - required:
            - removeFieldsParameters
          type: object
        - required:
            - jsonStringifyParameters
          type: object
        - required:
            - jsonParseParameters
          type: object
        - type: object
          not:
            anyOf:
              - required:
                  - extractParameters
                type: object
              - required:
                  - jsonExtractParameters
                type: object
              - required:
                  - replaceParameters
                type: object
              - required:
                  - parseParameters
                type: object
              - required:
                  - allowParameters
                type: object
              - required:
                  - blockParameters
                type: object
              - required:
                  - extractTimestampParameters
                type: object
              - required:
                  - removeFieldsParameters
                type: object
              - required:
                  - jsonStringifyParameters
                type: object
              - required:
                  - jsonParseParameters
                type: object
      properties:
        allowParameters:
          $ref: '#/components/schemas/AllowParameters'
        blockParameters:
          $ref: '#/components/schemas/BlockParameters'
        extractParameters:
          $ref: '#/components/schemas/ExtractParameters'
        extractTimestampParameters:
          $ref: '#/components/schemas/ExtractTimestampParameters'
        jsonExtractParameters:
          $ref: '#/components/schemas/JsonExtractParameters'
        jsonParseParameters:
          $ref: '#/components/schemas/JsonParseParameters'
        jsonStringifyParameters:
          $ref: '#/components/schemas/JsonStringifyParameters'
        parseParameters:
          $ref: '#/components/schemas/ParseParameters'
        removeFieldsParameters:
          $ref: '#/components/schemas/RemoveFieldsParameters'
        replaceParameters:
          $ref: '#/components/schemas/ReplaceParameters'
      description: Rule parameters.
      externalDocs:
        url: ''
    AllowParameters:
      type: object
      properties:
        keepBlockedLogs:
          type: boolean
          description: The keep blocked logs.
        rule:
          minLength: 0
          type: string
          description: Rule.
      description: Allow parameters.
      externalDocs:
        url: ''
    BlockParameters:
      type: object
      properties:
        keepBlockedLogs:
          type: boolean
          description: The keep blocked logs.
        rule:
          minLength: 0
          type: string
          description: Rule.
      description: Block parameters.
      externalDocs:
        url: ''
    ExtractParameters:
      type: object
      properties:
        rule:
          minLength: 0
          type: string
          description: Rule.
      description: Extract parameters.
      externalDocs:
        url: ''
    ExtractTimestampParameters:
      type: object
      properties:
        format:
          minLength: 0
          type: string
          description: The format.
        standard:
          $ref: '#/components/schemas/FormatStandard'
      description: Extract timestamp parameters.
      externalDocs:
        url: ''
    JsonExtractParameters:
      type: object
      properties:
        destinationFieldText:
          minLength: 0
          type: string
          description: The destination field text.
        destinationFieldType:
          $ref: '#/components/schemas/DestinationField'
        rule:
          minLength: 0
          type: string
          description: Rule.
      description: Json extract parameters.
      externalDocs:
        url: ''
    JsonParseParameters:
      type: object
      properties:
        deleteSource:
          type: boolean
          description: The delete source.
        destinationField:
          minLength: 0
          type: string
          description: The destination field.
        escapedValue:
          type: boolean
          description: The escaped value.
        overrideDest:
          type: boolean
          description: The override dest.
      description: Json parse parameters.
      externalDocs:
        url: ''
    JsonStringifyParameters:
      type: object
      properties:
        deleteSource:
          type: boolean
          description: The delete source.
        destinationField:
          minLength: 0
          type: string
          description: The destination field.
      description: Json stringify parameters.
      externalDocs:
        url: ''
    ParseParameters:
      type: object
      properties:
        destinationField:
          minLength: 0
          type: string
          description: The destination field.
        rule:
          minLength: 0
          type: string
          description: Rule.
      description: Parse parameters.
      externalDocs:
        url: ''
    RemoveFieldsParameters:
      type: object
      properties:
        fields:
          minItems: 0
          type: array
          items:
            minLength: 0
            type: string
            description: List of fields.
          description: List of fields.
      description: Remove fields parameters.
      externalDocs:
        url: ''
    ReplaceParameters:
      type: object
      properties:
        destinationField:
          minLength: 0
          type: string
          description: The destination field.
        replaceNewVal:
          minLength: 0
          type: string
          description: The replace new val.
        rule:
          minLength: 0
          type: string
          description: Rule.
      description: Replace parameters.
      externalDocs:
        url: ''
    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
      description: Format standard.
    DestinationField:
      enum:
        - DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED
        - DESTINATION_FIELD_CLASSNAME
        - DESTINATION_FIELD_METHODNAME
        - DESTINATION_FIELD_THREADID
        - DESTINATION_FIELD_SEVERITY
        - DESTINATION_FIELD_TEXT
      type: string
      description: Destination field.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````