# \VariableApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_variable**](VariableApi.md#create_variable) | **POST** /w/{workspace}/variables/create | create variable
[**delete_variable**](VariableApi.md#delete_variable) | **DELETE** /w/{workspace}/variables/delete/{path} | delete variable
[**delete_variables_bulk**](VariableApi.md#delete_variables_bulk) | **DELETE** /w/{workspace}/variables/delete_bulk | delete variables in bulk
[**encrypt_value**](VariableApi.md#encrypt_value) | **POST** /w/{workspace}/variables/encrypt | encrypt value
[**exists_variable**](VariableApi.md#exists_variable) | **GET** /w/{workspace}/variables/exists/{path} | does variable exists at path
[**get_variable**](VariableApi.md#get_variable) | **GET** /w/{workspace}/variables/get/{path} | get variable
[**get_variable_value**](VariableApi.md#get_variable_value) | **GET** /w/{workspace}/variables/get_value/{path} | get variable value
[**list_contextual_variables**](VariableApi.md#list_contextual_variables) | **GET** /w/{workspace}/variables/list_contextual | list contextual variables
[**list_variable**](VariableApi.md#list_variable) | **GET** /w/{workspace}/variables/list | list variables
[**update_variable**](VariableApi.md#update_variable) | **POST** /w/{workspace}/variables/update/{path} | update variable



## create_variable

> String create_variable(workspace, create_variable, already_encrypted)
create variable

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**create_variable** | [**CreateVariable**](CreateVariable.md) | new variable | [required] |
**already_encrypted** | Option<**bool**> | whether the variable is already encrypted (default false) |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_variable

> String delete_variable(workspace, path)
delete variable

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_variables_bulk

> Vec<String> delete_variables_bulk(workspace, delete_variables_bulk_request)
delete variables in bulk

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**delete_variables_bulk_request** | [**DeleteVariablesBulkRequest**](DeleteVariablesBulkRequest.md) | paths to delete | [required] |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## encrypt_value

> String encrypt_value(workspace, body)
encrypt value

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**body** | **String** | new variable | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## exists_variable

> bool exists_variable(workspace, path)
does variable exists at path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**bool**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_variable

> models::ListableVariable get_variable(workspace, path, decrypt_secret, include_encrypted)
get variable

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**decrypt_secret** | Option<**bool**> | ask to decrypt secret if this variable is secret (if not secret no effect, default: true)  |  |
**include_encrypted** | Option<**bool**> | ask to include the encrypted value if secret and decrypt secret is not true (default: false)  |  |

### Return type

[**models::ListableVariable**](ListableVariable.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_variable_value

> String get_variable_value(workspace, path, allow_cache)
get variable value

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**allow_cache** | Option<**bool**> | allow getting a cached value for improved performance  |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_contextual_variables

> Vec<models::ContextualVariable> list_contextual_variables(workspace)
list contextual variables

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**Vec<models::ContextualVariable>**](ContextualVariable.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_variable

> Vec<models::ListableVariable> list_variable(workspace, path_start, path, description, value, broad_filter, page, per_page, label)
list variables

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path_start** | Option<**String**> | filter variables by path prefix |  |
**path** | Option<**String**> | exact path match filter |  |
**description** | Option<**String**> | pattern match filter for description field (case-insensitive) |  |
**value** | Option<**String**> | pattern match filter for non-secret variable values (case-insensitive) |  |
**broad_filter** | Option<**String**> | broad search across multiple fields (case-insensitive substring match) |  |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**label** | Option<**String**> | Filter by label |  |

### Return type

[**Vec<models::ListableVariable>**](ListableVariable.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_variable

> String update_variable(workspace, path, edit_variable, already_encrypted)
update variable

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**edit_variable** | [**EditVariable**](EditVariable.md) | updated variable | [required] |
**already_encrypted** | Option<**bool**> | whether the variable is already encrypted (default false) |  |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

