Create a new Bucket for a Rate Limit

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

TODO: Resource-level docs

Create a new Bucket 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.

Body

  • Interval integer Required

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

  • Max integer Required

    Maximum number of requests permitted in during the interval.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • 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.
POST /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets 
curl \
 -X POST https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Interval=42&Max=42'
Request example 
{
  "Interval": 42,
  "Max": 42
}
Request examples 
{
  "Interval": 42,
  "Max": 42
}
Response examples (201) 
{
  "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"
}
Response examples (201) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "interval": 42,
  "max": 42,
  "rate_limit_sid": "string",
  "service_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}