Retrieve a list of all Buckets for a Rate Limit.

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

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.

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

  • RateLimitSid string Required

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

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

Query parameters

  • PageSize integer(int64)

    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.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

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

        A 34 character 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}$.

      • rate_limit_sid string | null

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

        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 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}$.

      • account_sid string | null

        The SID of the Account that created the Rate Limit resource.

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

      • max integer

        Maximum number of requests permitted in during the interval.

        Default value is 0.

      • interval integer

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

        Default value is 0.

      • date_created string(date-time) | null

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

      • date_updated string(date-time) | null

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

      • url string(uri) | null

        The URL of this resource.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets
curl \
 --request GET 'https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "buckets",
    "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "buckets": []
}
{
  "meta": {
    "key": "buckets",
    "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "buckets": [
    {
      "max": 5,
      "sid": "BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://verify.twilio.com/v2/Services/VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RateLimits/RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Buckets/BLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "interval": 60,
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "service_sid": "VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2015-07-30T20:00:00Z",
      "date_updated": "2015-07-30T20:00:00Z",
      "rate_limit_sid": "RKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}