Sign in
Event Gateways

Update Event Gateway

Update an individual gateway.

put/v1/event-gateways/{gatewayId}

Request body

namestring

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 not be updated.

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 updating 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 4 of the 29 revisions of this API.1116

  • 0325d14dfc53112See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the new optional request property min_runtime_version

      new-optional-request-property

    • ○

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

      response-body-all-of-removed

    • ○

      added the optional property description to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property labels to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property created_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property id to the response with the 200 status

      response-required-property-added

    • ○

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

      response-required-property-added

    • ○

      added the required property name to the response with the 200 status

      response-required-property-added

    • ○

      added the required property nodes_total to the response with the 200 status

      response-required-property-added

    • ○

      added the required property updated_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property version to the response with the 200 status

      response-required-property-added

    • ○

      added the required property virtual_clusters_total to the response with the 200 status

      response-required-property-added

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

  • 3575228c4a981See the full diff
    • ○

      api operation id update-houdini-event-gateway removed and replaced with update-event-gateway

      api-operation-id-removed

  • 5d2b35832e3f12See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    • ○

      api tag Event Gateways added

      api-tag-added

    • ○

      api tag Houdini Event Gateways removed

      api-tag-removed

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

  • ecce2daf9de61See the full diff
    • ○

      endpoint added

      endpoint-added