---
title: "Create Cluster Policy for Virtual Cluster"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19/operations/create-event-gateway-virtual-cluster-cluster-level-policy"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-event-gateways-1/versions/f4366232-3186-4be9-93bd-be3e4b16fb19.md

# Create Cluster Policy for Virtual Cluster

`POST` `/event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policies`

Operation ID: `create-event-gateway-virtual-cluster-cluster-level-policy`

Creates a new cluster-level policy associated with the specified Event Gateway virtual cluster.

## Path parameters

- `gatewayId` (string, uuid, required) - The UUID of your Gateway.
- `virtualClusterId` (string, uuid, required) - The ID of the Virtual Cluster.

## Query parameters

- `before` (string, uuid, optional) - Determines the id of the existing policy the new policy should be inserted before. Either 'before' or 'after' can be provided, when both are omitted the new policy is added to the end of the chain. When both are provided, the request fails with a 400 Bad Request.
- `after` (string, uuid, optional) - Determines the id of the existing policy the new policy should be inserted after. Either 'before' or 'after' can be provided, when both are omitted the new policy is added to the end of the chain. When both are provided, the request fails with a 400 Bad Request.

## Request body

Content types: `application/json`

## Responses

- `201` - Created
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for Event Gateways
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /event-gateways/{gatewayId}/virtual-clusters/{virtualClusterId}/cluster-policies:
    parameters:
      - $ref: "#/components/parameters/gatewayId"
      - $ref: "#/components/parameters/virtualClusterId"
    post:
      operationId: create-event-gateway-virtual-cluster-cluster-level-policy
      summary: Create Cluster Policy for Virtual Cluster
      description: Creates a new cluster-level policy associated with the specified
        Event Gateway virtual cluster.
      parameters:
        - $ref: "#/components/parameters/EventGatewayPolicyBefore"
        - $ref: "#/components/parameters/EventGatewayPolicyAfter"
      requestBody:
        $ref: "#/components/requestBodies/CreateEventGatewayClusterPolicyRequest"
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventGatewayPolicy"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Event Gateway Virtual Cluster Policies
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    gatewayId:
      name: gatewayId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: The UUID of your Gateway.
    virtualClusterId:
      schema:
        type: string
        format: uuid
      name: virtualClusterId
      in: path
      required: true
      description: The ID of the Virtual Cluster.
    EventGatewayPolicyBefore:
      schema:
        type: string
        format: uuid
      in: query
      name: before
      description: >
        Determines the id of the existing policy the new policy should be
        inserted before. Either 'before' or 'after' can be provided, when both
        are omitted the new policy is added to the end of the chain. When both
        are provided, the request fails with a 400 Bad Request.
      required: false
    EventGatewayPolicyAfter:
      schema:
        type: string
        format: uuid
      in: query
      name: after
      description: >
        Determines the id of the existing policy the new policy should be
        inserted after. Either 'before' or 'after' can be provided, when both
        are omitted the new policy is added to the end of the chain. When both
        are provided, the request fails with a 400 Bad Request.
      required: false
  requestBodies:
    CreateEventGatewayClusterPolicyRequest:
      description: The request schema for creating a cluster-level policy.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/EventGatewayClusterPolicyModify"
  schemas:
    EventGatewayPolicy:
      description: A policy associated with an Event Gateway.
      type: object
      properties:
        type:
          description: The type name of the policy.
          type: string
          maxLength: 255
          minLength: 1
        name:
          description: A unique user-defined name of the policy.
          type: string
          maxLength: 255
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the policy.
          type: string
          default: ""
          maxLength: 512
        enabled:
          description: Whether the policy is enabled.
          type: boolean
          default: true
        labels:
          $ref: "#/components/schemas/Labels"
        id:
          description: The unique identifier of the policy.
          type: string
          format: uuid
        config:
          description: The configuration of the policy.
          type: object
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        parent_policy_id:
          description: The unique identifier of the parent policy, if any.
          type: string
          format: uuid
          nullable: true
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        condition:
          description: A string containing the boolean expression that determines whether
            the policy is applied.
          type: string
          default: ""
          maxLength: 1000
          x-expression:
            type: boolean
            fields: []
      required:
        - type
        - id
        - created_at
        - updated_at
    EventGatewayClusterPolicyModify:
      description: The typed schema of the cluster policy to modify it.
      discriminator:
        propertyName: type
        mapping:
          acls: "#/components/schemas/EventGatewayACLsPolicy"
      oneOf:
        - $ref: "#/components/schemas/EventGatewayACLsPolicy"
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    EventGatewayACLsPolicy:
      description: Apply Kafka ACLs to virtual cluster traffic.
      type: object
      properties:
        type:
          description: The type name of the policy.
          type: string
          enum:
            - acls
          maxLength: 255
          minLength: 1
          x-terraform-transform-const: true
        name:
          description: A unique user-defined name of the policy.
          type: string
          maxLength: 255
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
        description:
          description: A human-readable description of the policy.
          type: string
          default: ""
          maxLength: 512
        enabled:
          description: Whether the policy is enabled.
          type: boolean
          default: true
        labels:
          $ref: "#/components/schemas/Labels"
        config:
          description: The configuration of the policy.
          type: object
          $ref: "#/components/schemas/EventGatewayACLPolicyConfig"
        condition:
          description: A string containing the boolean expression that determines whether
            the policy is applied.
          type: string
          example: context.auth.principal.name == "this-user"
          default: ""
          maxLength: 1000
          x-expression:
            type: boolean
            fields:
              - name: context.auth.principal.name
                type: string
                description: Name of authenticated principal. Username in case of PLAIN/SCRAM,
                  `sub` claim in case of OAUTHBEARER.
              - name: context.auth.type
                type: string
                description: >
                  The matched authentication type from a virtual cluster:
                  anonymous, sasl_plain, sasl_scram_sha256, sasl_scram_sha512,
                  sasl_oauth_bearer.
      required:
        - type
        - config
      title: ACL
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    EventGatewayACLPolicyConfig:
      description: Apply ACLs to virtual cluster traffic.
      type: object
      properties:
        rules:
          description: Every ACL rule in this list applies independently.
          type: array
          items:
            $ref: "#/components/schemas/EventGatewayACLRule"
          minItems: 1
      required:
        - rules
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    EventGatewayACLRule:
      description: A Kafka ACL rule to apply to virtual cluster traffic
      type: object
      properties:
        resource_type:
          description: This rule applies to access only for type of resource
          type: string
          enum:
            - topic
            - group
            - transactional_id
            - cluster
        action:
          description: How to handle the request if the rule matches
          type: string
          enum:
            - allow
            - deny
        operations:
          description: Types of Kafka operations to match against. Note that not every
            operation can apply to every resource type.
          type: array
          items:
            $ref: "#/components/schemas/EventGatewayACLOperation"
        resource_names:
          description: If any of these entries match, the resource name matches for this
            rule. A maximum of 50 entries are allowed.
          oneOf:
            - $ref: "#/components/schemas/EventGatewayACLRuleResourceNamesStaticArray"
            - $ref: "#/components/schemas/EventGatewayACLRuleResourceNamesDynamicArray"
      required:
        - resource_type
        - action
        - operations
        - resource_names
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
    EventGatewayACLOperation:
      description: An Event Gateway operation to match against in an ACL rule.
      type: object
      properties:
        name:
          type: string
          enum:
            - all
            - alter
            - alter_configs
            - create
            - delete
            - describe
            - describe_configs
            - idempotent_write
            - read
            - write
      required:
        - name
    EventGatewayACLRuleResourceNamesStaticArray:
      description: A static list of resource name globs to match against resources
        when applying an ACL policy.
      type: array
      items:
        $ref: "#/components/schemas/EventGatewayACLResourceName"
      example:
        - match: orders-*
        - match: payments-*
      maxItems: 50
    EventGatewayACLRuleResourceNamesDynamicArray:
      description: >-
        This expression should evaluate to an array of glob patterns,

        equivalent to the `match` values in the static array form of
        `resource_names`.


        **Requires a minimum runtime version of `1.1`**.
      type: string
      example: context.auth.token.claims["topics"]
      x-expression:
        type: array
        items:
          type: string
        fields:
          - name: context.auth.principal.name
            type: string
            description: Name of authenticated principal. Username in case of PLAIN/SCRAM,
              `sub` claim in case of OAUTHBEARER.
          - name: context.auth.type
            type: string
            description: >
              The matched authentication type from a virtual cluster: anonymous,
              sasl_plain, sasl_scram_sha256, sasl_scram_sha512,
              sasl_oauth_bearer.
          - name: context.auth.token.claims
            type: object
            description: All claims from the JWT token. Only populated for sasl_oauth_bearer
              authentication. Claims can be strings, numbers, booleans, arrays
              or nested JSON objects.
      x-min-runtime-version: "1.1"
    EventGatewayACLResourceName:
      description: An Event Gateway resource name to match against in an ACL rule.
      type: object
      properties:
        match:
          description: >
            Currently supported are exact matches and globs.

            All `*` characters are interpreted as globs, i.e. they match zero or
            more of any character.
          type: string
          format: glob
      required:
        - match
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
