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

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

# ResourceAction

Contains information about a 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"
    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
    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)
    ResourceAction:
      title: ResourceAction
      description: Contains information about a resource action
      type: object
      additionalProperties: false
      required:
        - id
        - user_id
        - action_type
        - cause
        - service_id
        - resource_id
        - resource_name
        - integration
        - created_at
      properties:
        id:
          description: The resource action ID.
          type: string
          format: uuid
          example: 93b411db-6f68-47d2-8959-de2d91914f2f
        user_id:
          description: |
            Represents the user who performed the action.
            A `null` value represents that action was taken by the system.
          type: string
          nullable: true
        action_type:
          description: |
            Represents which action was performed on a resource:
              - `map`: a resource was mapped to a service
              - `unmap`: a resource was unmapped from a service
              - `archive`: a resource was archived
              - `restore`: a resource was restored
          type: string
          enum:
            - map
            - unmap
            - archive
            - restore
        cause:
          description: >
            Represents what caused the resource action to occur:

            - `user-action`: user performed a resource action

            - `suggestion-rule`: resource action performed based on the
            configuration of a suggestion rule
          type: string
          enum:
            - user-action
            - suggestion-rule
        service_id:
          description: The service effected by the resource action
          type: string
          format: uuid
          nullable: true
          example: 6567bdab-9a94-4763-a736-7638b777fc04
        resource_id:
          description: The resource effected by the resource action
          type: string
          example: R4bimspbBIFkYA1v
        resource_name:
          type: string
          nullable: true
          maxLength: 255
          description: The name of the resource affected by the resource action
          example: Billing Service
        integration:
          $ref: "#/components/schemas/IntegrationRef"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
```