Event Gateways

Create Event Gateway

Changed on

Create a Event gateway in the Konnect Organization.

post/v1/event-gateways

Request

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

Request body

namestring required

The name of the Gateway.

descriptionstring

A human-readable description of the Gateway.

min_runtime_versionstring

The minimum runtime version supported by the API. This is the lowest version of the data plane release that can be used with the entity model. When not specified, the minimum runtime version will be pinned to the latest available release.

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

Example request

{
  "min_runtime_version": "1.1",
  "labels": {
    "env": "test"
  }
}

Response

A response to creating a gateway.

idstring uuid required

The gateway ID.

namestring required

The name of the Gateway.

descriptionstring

A human-readable description of the Gateway.

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

created_atstring date-time required

An ISO-8604 timestamp representation of gateway creation date.

updated_atstring date-time required

An ISO-8604 timestamp representation of gateway update date.

nodes_totalinteger required

The total number of nodes associated with the Event Gateway.

virtual_clusters_totalinteger required

The total number of virtual clusters associated with the Event Gateway.

min_runtime_versionstring required

The minimum runtime version supported by the API. This is the lowest version of the data plane release that can be used with the entity model. When not specified, the minimum runtime version will be pinned to the latest available release.

versionstring required

The version number of the event gateway. Every change to an entity under this gateway will modify the version.

Example response

{
  "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "min_runtime_version": "1.1",
  "version": "v1.123"
}

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

    • warning

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

    • warning

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