github.com/twilio/twilio-go@v1.20.1/rest/verify/v2/docs/ServicesRateLimitsBucketsApi.md (about)

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