Event Gateway Virtual Cluster Produce Policies

List Produce Policies for Virtual Cluster

Changed on

Returns a list of produce policies associated with the specified Event Gateway virtual cluster.

get/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/produce-policies
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

parent_policy_idstring

The ID of the parent policy.

Filter policies returned in the response.

Response

A paginated list response for a collection of produce policies associated with an Event Gateway virtual cluster.

typestring required

The type name of the policy.

namestring

A unique user-defined name of the policy.

descriptionstring

A human-readable description of the policy.

enabledboolean

Whether the policy is enabled.

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

idstring uuid required

The unique identifier of the policy.

configobject

The configuration of the policy.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

parent_policy_idstring uuid nullable

The unique identifier of the parent policy, if any.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

conditionstring

A string containing the boolean expression that determines whether the policy is applied.

Example response

[
  {
    "labels": {
      "env": "test"
    },
    "created_at": "2022-11-04T20:10:06.927Z",
    "updated_at": "2022-11-04T20:10:06.927Z"
  }
]

Changes

  • 68d43091b84dRevision changes
    • warning

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

  • f324fb7610e4Revision changes
    • 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

      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