All URIs are relative to http://localhost/api/v1
Method | HTTP request | Description |
---|---|---|
DeleteVariable | Delete /variables/{variable_key} | Delete variable |
GetVariable | Get /variables/{variable_key} | Get a variable by key |
GetVariables | Get /variables | Get all variables |
PatchVariable | Patch /variables/{variable_key} | Update a variable by key |
PostVariables | Post /variables | Create a variable |
DeleteVariable(ctx, variableKey)
Delete variable
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
variableKey | string | The Variable Key. |
(empty response body)
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Variable GetVariable(ctx, variableKey)
Get a variable by key
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
variableKey | string | The Variable Key. |
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VariableCollection GetVariables(ctx, optional)
Get all variables
The collection does not contain data. To get data, you must get a single entity.
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *GetVariablesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetVariablesOpts struct
Name | Type | Description | Notes |
---|---|---|---|
limit | optional.Int32 | The numbers of items to return. | [default to 100] |
offset | optional.Int32 | The number of items to skip before starting to collect the result set. |
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Variable PatchVariable(ctx, variableKey, variable, optional)
Update a variable by key
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
variableKey | string | The Variable Key. | |
variable | Variable | ||
optional | *PatchVariableOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a PatchVariableOpts struct
Name | Type | Description | Notes |
---|
updateMask | optional.Interface of []string| The fields to update on the connection (connection, pool etc). If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. |
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Variable PostVariables(ctx, variable)
Create a variable
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
variable | Variable |
No authorization required
[Back to top] [Back to API list] [Back to Model list] [Back to README]