Rate Limiting

Add this section to your kong.yaml configuration file:

_format_version: "3.0"
plugins:
  - name: rate-limiting
    config:
      limit_by: principal
      custom_key: unknown-partner
      second: 10
    expressions:
      custom_key: principal.metadata.partner_id
      second: principal.metadata.rate_limit

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• region: Geographic region where your Kong Konnect is hosted and operates.

• KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

• controlPlaneId: The id of the control plane.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

Add this section to your kong.yaml configuration file:

_format_version: "3.0"
plugins:
  - name: rate-limiting
    service: serviceName|Id
    config:
      limit_by: principal
      custom_key: unknown-partner
      second: 10
    expressions:
      custom_key: principal.metadata.partner_id
      second: principal.metadata.rate_limit

Make sure to replace the following placeholders with your own values:

• serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• region: Geographic region where your Kong Konnect is hosted and operates.

• KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

• controlPlaneId: The id of the control plane.

• serviceId: The id of the service the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

Add this section to your kong.yaml configuration file:

_format_version: "3.0"
plugins:
  - name: rate-limiting
    route: routeName|Id
    config:
      limit_by: principal
      custom_key: unknown-partner
      second: 10
    expressions:
      custom_key: principal.metadata.partner_id
      second: principal.metadata.rate_limit

Make sure to replace the following placeholders with your own values:

• routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• region: Geographic region where your Kong Konnect is hosted and operates.

• KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

• controlPlaneId: The id of the control plane.

• routeId: The id of the route the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

Add this section to your kong.yaml configuration file:

_format_version: "3.0"
plugins:
  - name: rate-limiting
    consumer: consumerName|Id
    config:
      limit_by: principal
      custom_key: unknown-partner
      second: 10
    expressions:
      custom_key: principal.metadata.partner_id
      second: principal.metadata.rate_limit

Make sure to replace the following placeholders with your own values:

• consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• region: Geographic region where your Kong Konnect is hosted and operates.

• KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

• controlPlaneId: The id of the control plane.

• consumerId: The id of the consumer the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

Add this section to your kong.yaml configuration file:

_format_version: "3.0"
plugins:
  - name: rate-limiting
    consumer_group: consumerGroupName|Id
    config:
      limit_by: principal
      custom_key: unknown-partner
      second: 10
    expressions:
      custom_key: principal.metadata.partner_id
      second: principal.metadata.rate_limit

Make sure to replace the following placeholders with your own values:

• consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{consumerGroupId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "rate-limiting",
      "config": {
        "limit_by": "principal",
        "custom_key": "unknown-partner",
        "second": 10
      },
      "expressions": {
        "custom_key": "principal.metadata.partner_id",
        "second": "principal.metadata.rate_limit"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

• region: Geographic region where your Kong Konnect is hosted and operates.

• KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

• controlPlaneId: The id of the control plane.

• consumerGroupId: The id of the consumer group the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.