---
title: "Create a route shared policy chain policy"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-for-api-gateways-dev-1/versions/a1769dd8-5923-4feb-8924-2e1ea4c75174/operations/create-api-gateway-route-shared-policy-chain-inbound-policy"
---

> 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

# Create a route shared policy chain policy

`POST` `/api-gateways/{gatewayId}/shared-policies/routes/{apiGatewaySharedPolicyChainId}/inbound-policies`

Operation ID: `create-api-gateway-route-shared-policy-chain-inbound-policy`

Create a route shared policy chain inbound policy

## Path parameters

- `apiGatewaySharedPolicyChainId` (string, uuid, required) - The ID of the API Gateway Shared Policy Chain.
- `gatewayId` (string, uuid, required) - The UUID of your Gateway.

## Request body (required)

Content types: `application/json`

## Responses

- `201` - An API Gateway policy
- `400` - Bad Request

## 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
paths:
  /api-gateways/{gatewayId}/shared-policies/routes/{apiGatewaySharedPolicyChainId}/inbound-policies:
    parameters:
      - $ref: "#/components/parameters/gatewayId"
      - $ref: "#/components/parameters/apiGatewaySharedPolicyChainId"
    post:
      operationId: create-api-gateway-route-shared-policy-chain-inbound-policy
      summary: Create a route shared policy chain policy
      description: Create a route shared policy chain inbound policy
      parameters:
        - $ref: "#/components/parameters/gatewayId"
      requestBody:
        $ref: "#/components/requestBodies/CreateAPIGatewayRouteInboundPolicy"
      responses:
        "201":
          $ref: "#/components/responses/APIGatewayPolicy"
        "400":
          $ref: "#/components/responses/BadRequest"
      tags:
        - API Gateway Route Shared Inbound Policy Chain
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.
    apiGatewaySharedPolicyChainId:
      schema:
        type: string
        format: uuid
      name: apiGatewaySharedPolicyChainId
      in: path
      required: true
      description: The ID of the API Gateway Shared Policy Chain.
  requestBodies:
    CreateAPIGatewayRouteInboundPolicy:
      description: The route inbound policy to be created
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreateAPIGatewayRouteInboundPolicy"
  responses:
    APIGatewayPolicy:
      description: An API Gateway policy
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/APIGatewayPolicy"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
  schemas:
    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"
    APIGatewayPolicy:
      description: A policy that can be applied to an API Gateway.
      type: object
      properties:
        id:
          description: The ID of the policy
          type: string
          format: uuid
        type:
          description: The type identifier of the policy
          type: string
        name:
          description: The name of the policy
          type: string
        config:
          description: The configuration of the policy
          type: object
        parent_policy_id:
          description: The unique identifier of the parent policy, if any.
          type: string
          format: uuid
          nullable: true
        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
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        labels:
          $ref: "#/components/schemas/Labels"
      additionalProperties: false
      required:
        - id
        - type
        - config
        - created_at
        - updated_at
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    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
    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
    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"
    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
    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
    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
  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...'`
```
