---
title: "CreateAPIGatewayRouteInboundPolicy"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-api-gateways-dev-1/versions/a1769dd8-5923-4feb-8924-2e1ea4c75174/schemas/CreateAPIGatewayRouteInboundPolicy"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-api-gateways-dev-1/versions/a1769dd8-5923-4feb-8924-2e1ea4c75174.md

# CreateAPIGatewayRouteInboundPolicy

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Control Planes Configuration for API 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
components:
  schemas:
    PolicyChainReferencePolicy:
      allOf:
        - $ref: "#/components/schemas/BaseAPIGatewayPolicy"
        - type: object
          properties:
            type:
              type: string
              enum:
                - policy_chain_reference
            config:
              oneOf:
                - $ref: "#/components/schemas/PolicyChainReferenceById"
                - $ref: "#/components/schemas/PolicyChainReferenceByName"
          required:
            - type
            - config
    RateLimitPolicy:
      allOf:
        - $ref: "#/components/schemas/BaseAPIGatewayPolicy"
        - type: object
          properties:
            type:
              type: string
              enum:
                - rate_limit
            config:
              type: object
              additionalProperties: false
              properties:
                limit:
                  type: integer
                window_size:
                  type: integer
                bucket_key:
                  type: string
              required:
                - limit
                - window_size
          required:
            - type
            - config
    SetReqHeaderPolicy:
      allOf:
        - $ref: "#/components/schemas/BaseAPIGatewayPolicy"
        - type: object
          properties:
            type:
              type: string
              enum:
                - set_req_header
            config:
              $ref: "#/components/schemas/HeaderProperty"
          required:
            - type
            - config
    TerminatePolicy:
      allOf:
        - $ref: "#/components/schemas/BaseAPIGatewayPolicy"
        - type: object
          properties:
            type:
              type: string
              enum:
                - terminate
            config:
              type: object
              additionalProperties: false
              properties:
                status:
                  type: integer
                body:
                  type: string
              required:
                - status
                - body
          required:
            - type
            - config
    ForwardToSvcPolicy:
      allOf:
        - $ref: "#/components/schemas/BaseAPIGatewayPolicy"
        - type: object
          properties:
            type:
              type: string
              enum:
                - forward_to_svc
            config:
              type: object
              additionalProperties: false
              properties:
                service:
                  $ref: "#/components/schemas/APIGatewayServiceReferenceModify"
              required:
                - service
          required:
            - type
            - config
    BaseAPIGatewayPolicy:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        type:
          description: The type identifier of the policy
          type: string
        name:
          description: The name identifier of the policy
          type: string
        config:
          description: The configuration of the policy
          type: object
        condition:
          description: A string containing the boolean expression that determines whether
            the policy is applied.
          type: string
          example: context.introspect_token.claims.gold_tier == true
          maxLength: 1000
          minLength: 1
          x-expression:
            type: boolean
        parent_policy_id:
          description: The unique identifier of the parent policy, if any.
          type: string
          format: uuid
          nullable: true
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        labels:
          $ref: "#/components/schemas/Labels"
      required:
        - type
    PolicyChainReferenceById:
      description: Reference a policy chain by its unique identifier.
      type: object
      properties:
        id:
          description: The unique identifier of the policy chain.
          type: string
          format: uuid
      additionalProperties: false
      required:
        - id
    PolicyChainReferenceByName:
      description: Reference a policy chain by its unique name.
      type: object
      properties:
        name:
          description: The name of the shared policy chain to reference.
          type: string
      additionalProperties: false
      required:
        - name
    HeaderProperty:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
      additionalProperties: false
      required:
        - key
        - value
    APIGatewayServiceReferenceModify:
      description: A reference to an existing service, either by ID or by name.
      anyOf:
        - $ref: "#/components/schemas/APIGatewayServiceReferenceById"
        - $ref: "#/components/schemas/APIGatewayServiceReferenceByName"
    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
    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
    APIGatewayServiceReferenceById:
      description: A reference to an existing service by ID.
      type: object
      properties:
        id:
          description: The ID of the service
          type: string
          format: uuid
      required:
        - id
    APIGatewayServiceReferenceByName:
      description: A reference to an existing service by name.
      type: object
      properties:
        name:
          description: The name identifier of the service
          type: string
          maxLength: 255
          minLength: 1
          x-unicode-pattern: ^[\p{L}\p{N}][\p{L}\p{N} _\-\.:/+']*[\p{L}\p{N}]$
      required:
        - name
    CreateAPIGatewayRouteInboundPolicy:
      discriminator:
        propertyName: type
        mapping:
          policy_chain_reference: "#/components/schemas/PolicyChainReferencePolicy"
          rate_limit: "#/components/schemas/RateLimitPolicy"
          set_req_header: "#/components/schemas/SetReqHeaderPolicy"
          terminate: "#/components/schemas/TerminatePolicy"
          forward_to_svc: "#/components/schemas/ForwardToSvcPolicy"
      oneOf:
        - $ref: "#/components/schemas/PolicyChainReferencePolicy"
        - $ref: "#/components/schemas/RateLimitPolicy"
        - $ref: "#/components/schemas/SetReqHeaderPolicy"
        - $ref: "#/components/schemas/TerminatePolicy"
        - $ref: "#/components/schemas/ForwardToSvcPolicy"
```
