Retrieve a list of all Buckets for a Rate Limit

GET /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets

TODO: Resource-level docs

Retrieve a list of all Buckets for a Rate Limit.

Path parameters

  • ServiceSid string Required

    The SID of the Service the resource is associated with.

  • RateLimitSid string Required

    The Twilio-provided string that uniquely identifies the Rate Limit resource.

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • buckets array[object]
      Hide buckets attributes Show buckets attributes
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • date_created string(date-time) | null

        The RFC 2822 date and time in GMT when the resource was created

      • date_updated string(date-time) | null

        The RFC 2822 date and time in GMT when the resource was last updated

      • interval integer | null

        Number of seconds that the rate limit will be enforced over.

      • max integer | null

        Max number of requests.

      • rate_limit_sid string | null

        Rate Limit Sid.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RK[0-9a-fA-F]{32}$.

      • service_sid string | null

        The SID of the Service that the resource is associated with

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VA[0-9a-fA-F]{32}$.

      • sid string | null

        A string that uniquely identifies this Bucket.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BL[0-9a-fA-F]{32}$.

      • url string(uri) | null

        The URL of this resource.

    • meta object
      Hide meta attributes Show meta attributes
GET /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets 
curl \
 -X GET https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets \
 --user "username:password"
Response examples (200) 
{
  "buckets": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "interval": 42,
      "max": 42,
      "rate_limit_sid": "string",
      "service_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}