---
title: "IntegrationInstance"
url: "https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-1/versions/781fdf4f-a935-4ec1-9343-3203c8afd399/schemas/IntegrationInstance"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-service-catalog-1/versions/781fdf4f-a935-4ec1-9343-3203c8afd399.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:
      description: Short-hand descriptor of an integration that omits instance metadata.
      type: object
      properties:
        name:
          type: string
          example: gateway-manager
        display_name:
          type: string
          example: gateway-manager
      required:
        - name
        - display_name
    Labels:
      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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    IntegrationInstanceConfig:
      description: >
        JSON object representing configuration specific to the integration
        instance.

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