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

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

# IntegrationInstance

Information about an integration instance.

## 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:
    IntegrationRefWithoutInstance:
      type: object
      description: Short-hand descriptor of an integration that omits instance metadata.
      required:
        - name
        - display_name
      properties:
        name:
          type: string
          example: gateway-manager
        display_name:
          type: string
          example: gateway-manager
    IntegrationInstanceConfig:
      type: object
      x-speakeasy-type-override: any
      description: >
        JSON object representing configuration specific to the integration
        instance.

        The expected schema depends on the integration type and is dynamically
        registered at runtime.
      additionalProperties: true
      default: {}
      example:
        account_region: eu
    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
    IntegrationInstance:
      description: Information about an integration instance.
      type: object
      required:
        - id
        - name
        - display_name
        - description
        - integration
        - authorized
        - config
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: 3f51fa25-310a-421d-bd1a-007f859021a3
          description: The integration instance ID.
          readOnly: true
        name:
          type: string
          description: >
            The machine name of the integration instance that uniquely
            identifies it within the catalog.
          minLength: 1
          maxLength: 120
          pattern: ^[0-9a-z.-]+$
          example: aws-lambda-prod
        display_name:
          type: string
          description: The display name of the integration instance.
          minLength: 1
          maxLength: 120
          example: AWS (prod)
        description:
          type: string
          description: The description of the integration instance.
          nullable: true
          maxLength: 2048
        integration:
          $ref: "#/components/schemas/IntegrationRefWithoutInstance"
        authorized:
          type: boolean
          description: Denotes whether the integration instance has been authorized within
            the catalog.
          example: true
          readOnly: true
        config:
          $ref: "#/components/schemas/IntegrationInstanceConfig"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
```