---
title: "SystemSuggestionRule"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/SystemSuggestionRule"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# SystemSuggestionRule

Contains information about the system defined suggestion rule.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    SystemSuggestionRule:
      title: SystemSuggestionRule
      description: Contains information about the system defined suggestion rule.
      allOf:
        - type: object
          required:
            - id
            - name
            - description
            - binding
            - active
            - auto_accept
            - action
          properties:
            id:
              type: string
              format: uuid
              example: 22f72bd1-2897-473e-9471-302de3ccf38b
              description: The suggestion rule ID.
              readOnly: true
            name:
              type: string
              description: The display name of the suggestion rule.
              minLength: 1
              maxLength: 120
            description:
              type: string
              nullable: true
              default: null
              minLength: 1
              maxLength: 2048
              description: The description of the suggestion rule
              example: Suggestion rule description
            binding:
              type: string
              description: The integration binding object name
              example: pagerduty_service
            active:
              type: boolean
              description: Determines if this suggestion rule should be evaluated when
                generating suggested actions.
            auto_accept:
              type: boolean
              description: >
                Determines if the suggested action should be applied
                automatically.

                - `true`: Suggested action will be applied automatically

                - `false`: Suggested action will not be automatically applied,
                user input required
            action:
              type: object
              required:
                - type
              properties:
                type:
                  type: string
                  enum:
                    - archive
                    - map
                    - create-or-map
                  description: The type of action this system suggestion rule performs
              description: The action configuration for this system suggestion rule.
```