Sign in
Event Gateways

Create Event Gateway

Create a Event gateway in the Konnect Organization.

post/v1/event-gateways

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

Changed in 2 of the 75 revisions of this API.3

  • 5e6b2a1afead2See the full diff
    • ○

      added the new optional request property min_runtime_version

      new-optional-request-property

    • ○

      added the required property min_runtime_version to the response with the 201 status

      response-required-property-added

  • 581456e3279f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog