Integration Instances

Create Integration Instance

Changed on

Creates an integration instance.

post/v1/integration-instances

Request

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

Request body

integration_namestring required

The type of integration instance to create.

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

Optionally provide a description of the integration instance.

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.

Example request

{
  "integration_name": "aws-lambda",
  "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

  • f530bf400198Revision 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

  • 4a02153f2e60Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status