github.com/twilio/twilio-go@v1.20.1/rest/verify/v2/docs/ServicesRateLimitsApi.md (about) 1 # ServicesRateLimitsApi 2 3 All URIs are relative to *https://verify.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateRateLimit**](ServicesRateLimitsApi.md#CreateRateLimit) | **Post** /v2/Services/{ServiceSid}/RateLimits | 8 [**DeleteRateLimit**](ServicesRateLimitsApi.md#DeleteRateLimit) | **Delete** /v2/Services/{ServiceSid}/RateLimits/{Sid} | 9 [**FetchRateLimit**](ServicesRateLimitsApi.md#FetchRateLimit) | **Get** /v2/Services/{ServiceSid}/RateLimits/{Sid} | 10 [**ListRateLimit**](ServicesRateLimitsApi.md#ListRateLimit) | **Get** /v2/Services/{ServiceSid}/RateLimits | 11 [**UpdateRateLimit**](ServicesRateLimitsApi.md#UpdateRateLimit) | **Post** /v2/Services/{ServiceSid}/RateLimits/{Sid} | 12 13 14 15 ## CreateRateLimit 16 17 > VerifyV2RateLimit CreateRateLimit(ctx, ServiceSidoptional) 18 19 20 21 Create a new Rate Limit for a Service 22 23 ### Path Parameters 24 25 26 Name | Type | Description 27 ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. 30 31 ### Other Parameters 32 33 Other parameters are passed through a pointer to a CreateRateLimitParams struct 34 35 36 Name | Type | Description 37 ------------- | ------------- | ------------- 38 **UniqueName** | **string** | 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.** 39 **Description** | **string** | Description of this Rate Limit 40 41 ### Return type 42 43 [**VerifyV2RateLimit**](VerifyV2RateLimit.md) 44 45 ### Authorization 46 47 [accountSid_authToken](../README.md#accountSid_authToken) 48 49 ### HTTP request headers 50 51 - **Content-Type**: application/x-www-form-urlencoded 52 - **Accept**: application/json 53 54 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 55 [[Back to Model list]](../README.md#documentation-for-models) 56 [[Back to README]](../README.md) 57 58 59 ## DeleteRateLimit 60 61 > DeleteRateLimit(ctx, ServiceSidSid) 62 63 64 65 Delete a specific Rate Limit. 66 67 ### Path Parameters 68 69 70 Name | Type | Description 71 ------------- | ------------- | ------------- 72 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 73 **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. 74 **Sid** | **string** | The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. 75 76 ### Other Parameters 77 78 Other parameters are passed through a pointer to a DeleteRateLimitParams struct 79 80 81 Name | Type | Description 82 ------------- | ------------- | ------------- 83 84 ### Return type 85 86 (empty response body) 87 88 ### Authorization 89 90 [accountSid_authToken](../README.md#accountSid_authToken) 91 92 ### HTTP request headers 93 94 - **Content-Type**: Not defined 95 - **Accept**: Not defined 96 97 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 98 [[Back to Model list]](../README.md#documentation-for-models) 99 [[Back to README]](../README.md) 100 101 102 ## FetchRateLimit 103 104 > VerifyV2RateLimit FetchRateLimit(ctx, ServiceSidSid) 105 106 107 108 Fetch a specific Rate Limit. 109 110 ### Path Parameters 111 112 113 Name | Type | Description 114 ------------- | ------------- | ------------- 115 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 116 **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. 117 **Sid** | **string** | The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. 118 119 ### Other Parameters 120 121 Other parameters are passed through a pointer to a FetchRateLimitParams struct 122 123 124 Name | Type | Description 125 ------------- | ------------- | ------------- 126 127 ### Return type 128 129 [**VerifyV2RateLimit**](VerifyV2RateLimit.md) 130 131 ### Authorization 132 133 [accountSid_authToken](../README.md#accountSid_authToken) 134 135 ### HTTP request headers 136 137 - **Content-Type**: Not defined 138 - **Accept**: application/json 139 140 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 141 [[Back to Model list]](../README.md#documentation-for-models) 142 [[Back to README]](../README.md) 143 144 145 ## ListRateLimit 146 147 > []VerifyV2RateLimit ListRateLimit(ctx, ServiceSidoptional) 148 149 150 151 Retrieve a list of all Rate Limits for a service. 152 153 ### Path Parameters 154 155 156 Name | Type | Description 157 ------------- | ------------- | ------------- 158 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 159 **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. 160 161 ### Other Parameters 162 163 Other parameters are passed through a pointer to a ListRateLimitParams struct 164 165 166 Name | Type | Description 167 ------------- | ------------- | ------------- 168 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 169 **Limit** | **int** | Max number of records to return. 170 171 ### Return type 172 173 [**[]VerifyV2RateLimit**](VerifyV2RateLimit.md) 174 175 ### Authorization 176 177 [accountSid_authToken](../README.md#accountSid_authToken) 178 179 ### HTTP request headers 180 181 - **Content-Type**: Not defined 182 - **Accept**: application/json 183 184 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 185 [[Back to Model list]](../README.md#documentation-for-models) 186 [[Back to README]](../README.md) 187 188 189 ## UpdateRateLimit 190 191 > VerifyV2RateLimit UpdateRateLimit(ctx, ServiceSidSidoptional) 192 193 194 195 Update a specific Rate Limit. 196 197 ### Path Parameters 198 199 200 Name | Type | Description 201 ------------- | ------------- | ------------- 202 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 203 **ServiceSid** | **string** | The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with. 204 **Sid** | **string** | The Twilio-provided string that uniquely identifies the Rate Limit resource to fetch. 205 206 ### Other Parameters 207 208 Other parameters are passed through a pointer to a UpdateRateLimitParams struct 209 210 211 Name | Type | Description 212 ------------- | ------------- | ------------- 213 **Description** | **string** | Description of this Rate Limit 214 215 ### Return type 216 217 [**VerifyV2RateLimit**](VerifyV2RateLimit.md) 218 219 ### Authorization 220 221 [accountSid_authToken](../README.md#accountSid_authToken) 222 223 ### HTTP request headers 224 225 - **Content-Type**: application/x-www-form-urlencoded 226 - **Accept**: application/json 227 228 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 229 [[Back to Model list]](../README.md#documentation-for-models) 230 [[Back to README]](../README.md) 231