github.com/twilio/twilio-go@v1.20.1/rest/microvisor/v1/docs/SecretsApi.md (about)

     1  # SecretsApi
     2  
     3  All URIs are relative to *https://microvisor.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateAccountSecret**](SecretsApi.md#CreateAccountSecret) | **Post** /v1/Secrets | 
     8  [**DeleteAccountSecret**](SecretsApi.md#DeleteAccountSecret) | **Delete** /v1/Secrets/{Key} | 
     9  [**FetchAccountSecret**](SecretsApi.md#FetchAccountSecret) | **Get** /v1/Secrets/{Key} | 
    10  [**ListAccountSecret**](SecretsApi.md#ListAccountSecret) | **Get** /v1/Secrets | 
    11  [**UpdateAccountSecret**](SecretsApi.md#UpdateAccountSecret) | **Post** /v1/Secrets/{Key} | 
    12  
    13  
    14  
    15  ## CreateAccountSecret
    16  
    17  > MicrovisorV1AccountSecret CreateAccountSecret(ctx, optional)
    18  
    19  
    20  
    21  Create a secret for an Account.
    22  
    23  ### Path Parameters
    24  
    25  This endpoint does not need any path parameter.
    26  
    27  ### Other Parameters
    28  
    29  Other parameters are passed through a pointer to a CreateAccountSecretParams struct
    30  
    31  
    32  Name | Type | Description
    33  ------------- | ------------- | -------------
    34  **Key** | **string** | The secret key; up to 100 characters.
    35  **Value** | **string** | The secret value; up to 4096 characters.
    36  
    37  ### Return type
    38  
    39  [**MicrovisorV1AccountSecret**](MicrovisorV1AccountSecret.md)
    40  
    41  ### Authorization
    42  
    43  [accountSid_authToken](../README.md#accountSid_authToken)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: application/x-www-form-urlencoded
    48  - **Accept**: application/json
    49  
    50  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    51  [[Back to Model list]](../README.md#documentation-for-models)
    52  [[Back to README]](../README.md)
    53  
    54  
    55  ## DeleteAccountSecret
    56  
    57  > DeleteAccountSecret(ctx, Key)
    58  
    59  
    60  
    61  Delete a secret for an Account.
    62  
    63  ### Path Parameters
    64  
    65  
    66  Name | Type | Description
    67  ------------- | ------------- | -------------
    68  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    69  **Key** | **string** | The secret key; up to 100 characters.
    70  
    71  ### Other Parameters
    72  
    73  Other parameters are passed through a pointer to a DeleteAccountSecretParams struct
    74  
    75  
    76  Name | Type | Description
    77  ------------- | ------------- | -------------
    78  
    79  ### Return type
    80  
    81   (empty response body)
    82  
    83  ### Authorization
    84  
    85  [accountSid_authToken](../README.md#accountSid_authToken)
    86  
    87  ### HTTP request headers
    88  
    89  - **Content-Type**: Not defined
    90  - **Accept**: Not defined
    91  
    92  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    93  [[Back to Model list]](../README.md#documentation-for-models)
    94  [[Back to README]](../README.md)
    95  
    96  
    97  ## FetchAccountSecret
    98  
    99  > MicrovisorV1AccountSecret FetchAccountSecret(ctx, Key)
   100  
   101  
   102  
   103  Retrieve a Secret for an Account.
   104  
   105  ### Path Parameters
   106  
   107  
   108  Name | Type | Description
   109  ------------- | ------------- | -------------
   110  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   111  **Key** | **string** | The secret key; up to 100 characters.
   112  
   113  ### Other Parameters
   114  
   115  Other parameters are passed through a pointer to a FetchAccountSecretParams struct
   116  
   117  
   118  Name | Type | Description
   119  ------------- | ------------- | -------------
   120  
   121  ### Return type
   122  
   123  [**MicrovisorV1AccountSecret**](MicrovisorV1AccountSecret.md)
   124  
   125  ### Authorization
   126  
   127  [accountSid_authToken](../README.md#accountSid_authToken)
   128  
   129  ### HTTP request headers
   130  
   131  - **Content-Type**: Not defined
   132  - **Accept**: application/json
   133  
   134  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   135  [[Back to Model list]](../README.md#documentation-for-models)
   136  [[Back to README]](../README.md)
   137  
   138  
   139  ## ListAccountSecret
   140  
   141  > []MicrovisorV1AccountSecret ListAccountSecret(ctx, optional)
   142  
   143  
   144  
   145  Retrieve a list of all Secrets for an Account.
   146  
   147  ### Path Parameters
   148  
   149  This endpoint does not need any path parameter.
   150  
   151  ### Other Parameters
   152  
   153  Other parameters are passed through a pointer to a ListAccountSecretParams struct
   154  
   155  
   156  Name | Type | Description
   157  ------------- | ------------- | -------------
   158  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   159  **Limit** | **int** | Max number of records to return.
   160  
   161  ### Return type
   162  
   163  [**[]MicrovisorV1AccountSecret**](MicrovisorV1AccountSecret.md)
   164  
   165  ### Authorization
   166  
   167  [accountSid_authToken](../README.md#accountSid_authToken)
   168  
   169  ### HTTP request headers
   170  
   171  - **Content-Type**: Not defined
   172  - **Accept**: application/json
   173  
   174  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   175  [[Back to Model list]](../README.md#documentation-for-models)
   176  [[Back to README]](../README.md)
   177  
   178  
   179  ## UpdateAccountSecret
   180  
   181  > MicrovisorV1AccountSecret UpdateAccountSecret(ctx, Keyoptional)
   182  
   183  
   184  
   185  Update a secret for an Account.
   186  
   187  ### Path Parameters
   188  
   189  
   190  Name | Type | Description
   191  ------------- | ------------- | -------------
   192  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   193  **Key** | **string** | The secret key; up to 100 characters.
   194  
   195  ### Other Parameters
   196  
   197  Other parameters are passed through a pointer to a UpdateAccountSecretParams struct
   198  
   199  
   200  Name | Type | Description
   201  ------------- | ------------- | -------------
   202  **Value** | **string** | The secret value; up to 4096 characters.
   203  
   204  ### Return type
   205  
   206  [**MicrovisorV1AccountSecret**](MicrovisorV1AccountSecret.md)
   207  
   208  ### Authorization
   209  
   210  [accountSid_authToken](../README.md#accountSid_authToken)
   211  
   212  ### HTTP request headers
   213  
   214  - **Content-Type**: application/x-www-form-urlencoded
   215  - **Accept**: application/json
   216  
   217  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   218  [[Back to Model list]](../README.md#documentation-for-models)
   219  [[Back to README]](../README.md)
   220