---
title: "Update Integration Instance"
url: "https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f/operations/update-integration-instance"
---

> Full API specification: https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f.md

# Update Integration Instance

`PATCH` `/integration-instances/{id}`

Operation ID: `update-integration-instance`

Updates an integration instance.

## Path parameters

- `id` (string, required) - The `id` of the integration instance.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - A response containing a single integration instance object.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.2.0
servers:
  - url: https://us.api.konghq.com/v1
    description: US Region Base URL
  - url: https://eu.api.konghq.com/v1
    description: EU Region Base URL
  - url: https://au.api.konghq.com/v1
    description: AU Region Base URL
  - url: https://me.api.konghq.com/v1
    description: ME Region Base URL
  - url: https://in.api.konghq.com/v1
    description: IN Region Base URL
paths:
  /integration-instances/{id}:
    parameters:
      - schema:
          type: string
          example: 3f51fa25-310a-421d-bd1a-007f859021a3
        name: id
        in: path
        required: true
        description: The `id` of the integration instance.
    patch:
      x-speakeasy-entity-operation: IntegrationInstance#update
      x-unstable: true
      x-internal: true
      summary: Update Integration Instance
      operationId: update-integration-instance
      description: Updates an integration instance.
      requestBody:
        $ref: "#/components/requestBodies/UpdateIntegrationInstanceRequest"
      responses:
        "200":
          $ref: "#/components/responses/IntegrationInstanceResponse"
      tags:
        - Integration Instances
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  requestBodies:
    UpdateIntegrationInstanceRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/UpdateIntegrationInstance"
  responses:
    IntegrationInstanceResponse:
      description: A response containing a single integration instance object.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/IntegrationInstance"
  schemas:
    UpdateIntegrationInstance:
      type: object
      additionalProperties: false
      properties:
        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: Optionally provide a description of the integration instance.
          nullable: true
          maxLength: 2048
        config:
          $ref: "#/components/schemas/IntegrationInstanceConfig"
    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"
    IntegrationInstanceConfig:
      type: object
      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
    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
```