Service Rate Limits
Service Rate Limits makes it easy to use Twilio's battle-tested rate-limiting services to protect your Verify deployment. With Service Rate Limits, you can define the keys to meter and limits to enforce when starting user verifications. Together with Verify's built-in platform protections Service Rate Limits gives you turnkey protection with flexibility.
Prerequisites:
If you are just getting started with Rate Limits in Verify we recommend checking out our guide on Using Verify Service Rate Limits to Protect Your Application before diving into the API.
Rate Limit Properties
| Resource Properties in REST API format | |
|---|---|
sid
|
A 34 character string that uniquely identifies this Rate Limit. |
service_sid
|
The SID of the Service the resource is associated with. |
account_sid
|
The SID of the Account that created the Rate Limit resource. |
unique_name
|
Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII. |
description
|
Description of this Rate Limit |
date_created
|
The date and time in GMT when the resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT when the resource was last updated specified in RFC 2822 format. |
url
|
The URL of this resource. |
links
|
The URLs of related resources. |
Create a Rate Limit
https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits
The Rate Limit represents the key that your application will provide when starting a user verification request. For example, you may create a rate limit for an end-user IP address to prevent a malicious bot. See the section on Selecting Rate Limit Keys for information on this topic.
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service the resource is associated with. |
unique_name
Required
|
Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. This value should not contain PII. |
description
Optional
|
Description of this Rate Limit |
Example 1
Fetch a Rate Limit
https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service the resource is associated with. |
sid
Path
|
The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. |
Example 1
List all Rate Limits
https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service the resource is associated with. |
Example 1
Update a Rate Limit
https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service the resource is associated with. |
sid
Path
|
The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. |
description
Optional
|
Description of this Rate Limit |
Example 1
Delete a Rate Limit
https://verify.twilio.com/v2/Services/{ServiceSid}/RateLimits/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Service the resource is associated with. |
sid
Path
|
The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
