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

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

# SuggestedResourceAction

Contains information about a suggested resource action

## 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:
    IntegrationRef:
      type: object
      description: Short-hand descriptor of an integration installed within the catalog.
      required:
        - name
        - display_name
        - instance
      properties:
        name:
          type: string
          example: gateway-manager
        display_name:
          type: string
          example: gateway-manager
        instance:
          $ref: "#/components/schemas/IntegrationInstanceRef"
    SuggestedResourceAction:
      oneOf:
        - $ref: "#/components/schemas/ArchiveActionPayload"
        - $ref: "#/components/schemas/IgnoreActionPayload"
        - $ref: "#/components/schemas/MapServiceAction"
        - $ref: "#/components/schemas/CreateAndMapServiceActionPayload"
    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
    IntegrationInstanceRef:
      type: object
      description: Short-hand descriptor of an integration instance.
      required:
        - id
        - name
        - display_name
      properties:
        id:
          type: string
          format: uuid
          example: 772b9caf-ddbc-4f4f-8aa4-8dfbbe420351
          description: The integration instance ID.
        name:
          type: string
          description: >
            The machine name of the integration instance that uniquely
            identifies it within the catalog.
          pattern: ^[0-9a-z.-]+$
          example: aws-lambda-prod
        display_name:
          type: string
          description: The display name of the integration instance.
          example: AWS (prod)
    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
    MapServiceAction:
      title: MapServiceAction
      type: object
      additionalProperties: false
      required:
        - type
        - data
      properties:
        type:
          type: string
          enum:
            - map
        data:
          type: object
          additionalProperties: false
          required:
            - service
            - resource
          properties:
            service:
              type: object
              additionalProperties: false
              required:
                - id
              properties:
                id:
                  description: The identifier of the service associated to this resource action.
                  type: string
                  format: uuid
                  example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            resource:
              type: object
              additionalProperties: false
              required:
                - labels
              properties:
                labels:
                  $ref: "#/components/schemas/LabelsSuggestion"
    CreateAndMapServiceActionPayload:
      title: CreateAndMapServiceActionPayload
      type: object
      additionalProperties: false
      required:
        - type
        - data
      properties:
        type:
          type: string
          enum:
            - create
        data:
          type: object
          additionalProperties: false
          required:
            - service
            - resource
          properties:
            service:
              $ref: "#/components/schemas/CreateCatalogService"
            resource:
              type: object
              additionalProperties: false
              required:
                - labels
              properties:
                labels:
                  $ref: "#/components/schemas/LabelsSuggestion"
    LabelsSuggestion:
      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
    CreateCatalogService:
      type: object
      additionalProperties: false
      required:
        - name
        - display_name
      properties:
        name:
          type: string
          description: >
            The machine name of the Service that uniquely identifies it within
            the catalog.
          minLength: 1
          maxLength: 120
          pattern: ^[0-9a-z.-]+$
          example: user-svc
        display_name:
          type: string
          description: The display name of the Service.
          minLength: 1
          maxLength: 120
          example: User Service
        description:
          type: string
          description: Optionally provide a description of the Service.
          nullable: true
          maxLength: 2048
        labels:
          $ref: "#/components/schemas/Labels"
        custom_fields:
          $ref: "#/components/schemas/CustomFields"
    Labels:
      title: Labels
      type: object
      example:
        env: test
      maxProperties: 50
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
    CustomFields:
      type: object
      x-speakeasy-type-override: any
      description: >
        Map of customizable, catalog-defined fields providing information about
        a service.
      additionalProperties:
        x-convert-oneOf: true
        anyOf:
          - $ref: "#/components/schemas/TextCustomField"
          - $ref: "#/components/schemas/NumericCustomField"
          - $ref: "#/components/schemas/BooleanCustomField"
          - $ref: "#/components/schemas/UrlCustomField"
      example:
        owner: John Appleseed
        dashboard:
          name: On-Call Dashboard
          link: https://my-dashboard-svc.io/dashboards/1
    TextCustomField:
      type: string
      nullable: true
    NumericCustomField:
      type: number
      nullable: true
    BooleanCustomField:
      type: boolean
      nullable: true
    UrlCustomField:
      type: object
      nullable: true
      required:
        - name
        - link
      properties:
        name:
          description: The human-readable name of the URL link.
          type: string
          example: On-Call Dashboard
        link:
          description: The href value of the URL link.
          type: string
          format: uri-reference
          example: https://my-dashboard-svc.io/dashboards/1
    SuggestedResourceActionObject:
      title: SuggestedResourceAction
      description: Contains information about a suggested resource action
      allOf:
        - type: object
          required:
            - id
            - integration
            - suggestion_rule_id
            - entity_name
            - service_id
            - action
            - ignored
          properties:
            id:
              description: The suggested resource action rule ID.
              type: string
              example: 76ca0689-f08e-4c04-b2a6-4c992d89d554
            integration:
              $ref: "#/components/schemas/IntegrationRef"
            suggestion_rule_id:
              description: The identifier of the suggestion rule that generated this suggested
                resource action.
              type: string
              format: uuid
              nullable: true
              example: 22f72bd1-2897-473e-9471-302de3ccf38b
            entity_name:
              type: string
              description: The entity name of the discovered entity associated to this
                suggested action.
              example: My Service
            service_id:
              description: The identifier of the service this suggested resource action may
                act on.
              type: string
              format: uuid
              nullable: true
              example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            ignored:
              description: |
                Determines if this suggested action has been ignored or not.
                - `true`: Suggested action has been ignored
                - `false`: Suggested action is ready to be accepted or ignored
              type: boolean
              example: false
            action:
              $ref: "#/components/schemas/SuggestedResourceAction"
            created_at:
              $ref: "#/components/schemas/CreatedAt"
            updated_at:
              $ref: "#/components/schemas/UpdatedAt"
```