---
title: "Get a Suggestion Rule"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/operations/get-integration-suggestion-rule"
---

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

# Get a Suggestion Rule

`GET` `/integrations/{integration}/suggestion-rules/{suggestionRuleId}`

Operation ID: `get-integration-suggestion-rule`

Returns information about a suggestion rule from a given suggestion rule ID.

## Path parameters

- `integration` (string, required) - Machine name of the integration.
- `suggestionRuleId` (string, uuid, required) - ID of the suggestion rule.

## Responses

- `200` - A response containg a suggestion rule object.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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
paths:
  /integrations/{integration}/suggestion-rules/{suggestionRuleId}:
    parameters:
      - schema:
          type: string
          example: gateway-manager
        name: integration
        in: path
        required: true
        description: Machine name of the integration.
      - schema:
          type: string
          format: uuid
          example: 22f72bd1-2897-473e-9471-302de3ccf38b
        name: suggestionRuleId
        in: path
        required: true
        description: ID of the suggestion rule.
    get:
      x-unstable: true
      x-internal: true
      summary: Get a Suggestion Rule
      operationId: get-integration-suggestion-rule
      description: Returns information about a suggestion rule from a given suggestion
        rule ID.
      responses:
        "200":
          $ref: "#/components/responses/SuggestionRuleResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Suggestion Rules
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  responses:
    SuggestionRuleResponse:
      description: A response containg a suggestion rule object.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/SuggestionRule"
          examples:
            Suggestion Rule:
              $ref: "#/components/examples/SuggestionRule"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    SuggestionRule:
      title: SuggestionRule
      description: Contains information about the suggestion rule.
      allOf:
        - $ref: "#/components/schemas/SystemSuggestionRule"
        - type: object
          required:
            - created_at
            - updated_at
            - action
            - discovery_selector
          properties:
            created_at:
              $ref: "#/components/schemas/CreatedAt"
            updated_at:
              $ref: "#/components/schemas/UpdatedAt"
            discovery_selector:
              type: string
              description: >
                A boolean string or JQ expression that must evaluate to a
                boolean value.

                Supports JQ expressions syntax on discovered entity's
                `integration_record` property.
              example: .gateway_service.tags | contains(["_KonnectDeployment:"])
            action:
              $ref: "#/components/schemas/SuggestedRuleAction"
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    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.
    CreatedAt:
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      description: An ISO-8601 timestamp representation of entity creation date.
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    UpdatedAt:
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      description: An ISO-8601 timestamp representation of entity update date.
      readOnly: true
      x-speakeasy-param-suppress-computed-diff: true
    SuggestedRuleAction:
      oneOf:
        - $ref: "#/components/schemas/ArchiveActionPayload"
        - $ref: "#/components/schemas/IgnoreActionPayload"
        - $ref: "#/components/schemas/MapActionPayload"
        - $ref: "#/components/schemas/CreateOrMapAction"
    BaseError:
      type: object
      title: Error
      description: standard error
      required:
        - status
        - title
        - instance
        - detail
      properties:
        status:
          type: integer
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          readOnly: true
        title:
          type: string
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          readOnly: true
        type:
          type: string
          description: The error type.
          readOnly: true
        instance:
          type: string
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          readOnly: true
        detail:
          type: string
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          readOnly: true
    InvalidParameters:
      type: array
      nullable: false
      uniqueItems: true
      minItems: 1
      description: invalid parameters
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
    ArchiveActionPayload:
      title: ArchiveActionPayload
      type: object
      additionalProperties: false
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - archive
    IgnoreActionPayload:
      title: IgnoreAction
      type: object
      additionalProperties: false
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - ignore
    MapActionPayload:
      title: MapAction
      description: >
        Must specify **at least one** of the following properties when
        `action_type` is `map`:

        - `id`

        - `name`
      type: object
      additionalProperties: false
      required:
        - type
        - data
      properties:
        type:
          type: string
          enum:
            - map
        data:
          type: object
          additionalProperties: false
          required:
            - service
            - resource
          properties:
            service:
              oneOf:
                - $ref: "#/components/schemas/MapByName"
                - $ref: "#/components/schemas/MapById"
            resource:
              type: object
              additionalProperties: false
              required:
                - labels
              properties:
                labels:
                  $ref: "#/components/schemas/LabelsTemplate"
    CreateOrMapAction:
      title: CreateOrMapAction
      type: object
      required:
        - type
        - data
      properties:
        type:
          type: string
          enum:
            - create-or-map
        data:
          type: object
          additionalProperties: false
          required:
            - service
            - resource
          properties:
            service:
              type: object
              additionalProperties: false
              required:
                - name
                - display_name
                - description
                - labels
                - metadata
              properties:
                name:
                  description: >
                    The name of the service to create or map to.

                    Supports JQ expression syntax on discovered entity's
                    `integration_record` property.
                  type: string
                  minLength: 1
                display_name:
                  type: string
                  nullable: true
                  description: >
                    The display name of the service on create. This property is
                    ignored on map.

                    Supports JQ expression syntax on discovered entity's
                    `integration_record` property.

                    If value is set to null, display name will be set to name.
                  minLength: 1
                description:
                  type: string
                  description: >
                    The description of the service. This property is ignored on
                    map.

                    Supports JQ expression syntax on discovered entity's
                    `integration_record` property.
                labels:
                  $ref: "#/components/schemas/LabelsTemplate"
                metadata:
                  $ref: "#/components/schemas/MetadataTemplate"
            resource:
              type: object
              additionalProperties: false
              required:
                - labels
              properties:
                labels:
                  $ref: "#/components/schemas/LabelsTemplate"
    InvalidParameterStandard:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - max_length
            - max_items
            - max
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: false
          enum:
            - enum
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          uniqueItems: true
          readOnly: true
          nullable: false
          minItems: 1
          items: {}
        source:
          type: string
          example: body
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      additionalProperties: false
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          readOnly: true
          nullable: true
          enum:
            - dependent_fields
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          uniqueItems: true
          nullable: true
          items: {}
          readOnly: true
        source:
          type: string
          example: body
      required:
        - field
        - rule
        - reason
        - dependents
    MapByName:
      type: object
      additionalProperties: false
      required:
        - name
      properties:
        name:
          type: string
          description: >
            Exact match on service name based on suggestion rule scope.

            Supports JQ expression syntax on discovered entity's
            `integration_record` property.
          example: "{{ .gateway_service.name }}-{{ .runtime_group.labels.env }}"
    MapById:
      type: object
      additionalProperties: false
      required:
        - id
      properties:
        id:
          type: string
          description: >
            Exact match on service identifier based on suggestion rule scope.

            Supports JQ expression syntax on discovered entity's
            `integration_record` property.
          example: 1ace6cb5-75ca-4488-a05d-9260628a37a8
    LabelsTemplate:
      title: LabelsTemplate
      type: object
      example:
        env: test
      description: >
        Labels to facilitate grouping and tagged search.

        Resolved keys must be of length 1-63 characters, and cannot start with
        ''kong'', ''konnect'', ''mesh'', ''kic'', or ''_''.'

        Label key and value supports JQ expression syntax on discovered entity's
        `integration_record` property.
      additionalProperties:
        type: string
        minLength: 1
    MetadataTemplate:
      type: object
      description: Contains key value pairs information about entity's metadata.
        Supports JQ templates on values which resolves to a string.
      additionalProperties:
        anyOf:
          - type: string
            nullable: true
          - type: number
            nullable: true
          - type: boolean
            nullable: true
          - $ref: "#/components/schemas/UrlMetadataValueTemplate"
    InvalidRules:
      description: invalid parameters rules
      type: string
      readOnly: true
      nullable: true
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
    UrlMetadataValueTemplate:
      type: object
      description: Contains the name and link value associated with a URL Metadata
        Field. Supports JQ templates which resolves to a string.
      allOf:
        - $ref: "#/components/schemas/UrlMetadataValueBase"
        - type: object
          required:
            - link
          properties:
            link:
              description: The url link associated with the metadata value.
              type: string
              minLength: 1
              example: "#public-slack-channel"
    UrlMetadataValueBase:
      type: object
      nullable: true
      required:
        - name
      properties:
        name:
          description: The human-readable name for the url metadata value
          type: string
          minLength: 1
          example: "#public-slack-channel"
  examples:
    SuggestionRule:
      value:
        id: fa4d3c44-a6f9-4077-b75f-66760ed3dc19
        name: sample-datadog-monitors
        description: >-
          Rule to map all sample monitors to the sample service. Matches any
          monitor that satisfies one of the following:

          - monitor is tagged with a value with the prefix "service:sample"
          (ex:"service:sample", "service:sample-gateway-manager-app")
        auto_accept: true
        active: true
        binding: datadog_monitor
        discovery_selector: '| any(.tags[];  startswith("service:sample"))'
        action:
          type: map
          data:
            service:
              name: sample
            resource:
              labels: {}
        created_at: 2024-10-23T15:55:32.985Z
        updated_at: 2024-10-23T16:02:53.751Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```