
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# PUT rateService/rateLimits

Update rate limiter settings. The updated settings take effect immediately.

Since Product Version: 3.4

- Jump To

- v1
- v2
- v3
- v4

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

### Resource Information

Rate Limiting? | No
Sorting? | No
Paging? | No
Filtering? | No
Group Filtering? | No
Aggregation? | No
Response Formats | xml json
User Group | NBI Credential
HTTP Methods | PUT

## Resource URL

/webacs/api/v4/op/rateService/rateLimits

## Request Payload Parameters

Attribute | Description
--- | ---
limitPageSize int | This is the maximum size of a page that the user can request through .maxResults query parameter. Note that the value must be greater or equal to the limitUnpagedQuery attribute value.
limitUnpagedQuery int | This is the default size of a page returned when .maxResults query parameter is not specified. Note that the value must be lower or equal to the limitPageSize attribute value.
maxAllUserConcurrentQueries int | This is the number of concurrent requests allowed for all users. Use -1 to disable the limiting of all user concurrent requests.
maxConcurrentQueries int | This is the number of concurrent requests allowed for any given user.
perUserThreshold int | This is the number of requests for any given user that can be handled in windowsize ms. Use -1 to disable the limiting of per user requests.
totalRequestThreshold int | The number of total request that can be handled in windowsize ms. Use -1 to disable the limiting of total requests.
windowSegments int | This property is used internally to divide the window into segments. The number of segments determine the rate at which the window decrements the request counter. For example with 10 segments in a 1000 ms window, the count will be reduced every hundred ms, by the number of counts held in the oldest segment. (The count is increased immediately after receiving a new request). Note that windowSize/windowSegements must be a whole number.
windowSize int | Size of the sliding window used to count requests, in a milliseconds. Note that windowSize/windowSegements must be a whole number.

## Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

### Sample XML Request Payload

https://172.20.127.108/webacs/api/v4/op/rateService/rateLimits

    <?xml version="1.0" ?>
    <rateLimitsDTO>
      <limitPageSize>1</limitPageSize>
      <limitUnpagedQuery>1</limitUnpagedQuery>
      <maxAllUserConcurrentQueries>1</maxAllUserConcurrentQueries>
      <maxConcurrentQueries>1</maxConcurrentQueries>
      <perUserThreshold>1</perUserThreshold>
      <totalRequestThreshold>1</totalRequestThreshold>
      <windowSegments>1</windowSegments>
      <windowSize>1</windowSize>
    </rateLimitsDTO>

### Sample JSON Request Payload

https://172.20.127.108/webacs/api/v4/op/rateService/rateLimits.json

    {
      "rateLimitsDTO" : {
        "limitPageSize" : 1,
        "limitUnpagedQuery" : 1,
        "maxAllUserConcurrentQueries" : 1,
        "maxConcurrentQueries" : 1,
        "perUserThreshold" : 1,
        "totalRequestThreshold" : 1,
        "windowSegments" : 1,
        "windowSize" : 1
      }
    }