Integration Instances

Update Integration Instance

Changed on

Updates an integration instance.

patch/v1/integration-instances/{id}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/integration-instances/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring

The machine name of the integration instance that uniquely identifies it within the catalog.

display_namestring

The display name of the integration instance.

descriptionstring nullable

Optionally provide a description of the integration instance.

labelsLabelsUpdate nullable

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

configIntegrationInstanceConfig

JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime.

Example request

{
  "name": "aws-lambda-prod",
  "display_name": "AWS (prod)",
  "labels": {
    "env": "test"
  },
  "config": {
    "account_region": "eu"
  }
}

Response

A response containing a single integration instance object.

idstring uuid required

The integration instance ID.

namestring required

The machine name of the integration instance that uniquely identifies it within the catalog.

display_namestring required

The display name of the integration instance.

descriptionstring nullable required

The description of the integration instance.

authorizedboolean required

Denotes whether the integration instance has been authorized within the catalog.

labelsLabels

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 "_".

configIntegrationInstanceConfig required

JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "3f51fa25-310a-421d-bd1a-007f859021a3",
  "name": "aws-lambda-prod",
  "display_name": "AWS (prod)",
  "integration": {
    "name": "gateway-manager",
    "display_name": "gateway-manager"
  },
  "authorized": true,
  "labels": {
    "env": "test"
  },
  "config": {
    "account_region": "eu"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status