\VariableApi

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

DeleteVariable(ctx, variableKey)

Delete variable

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
variableKey	string	The Variable Key.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVariable

Variable GetVariable(ctx, variableKey)

Get a variable by key

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
variableKey	string	The Variable Key.

Return type

Variable

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetVariables

VariableCollection GetVariables(ctx, optional)

Get all variables

The collection does not contain data. To get data, you must get a single entity.

Required Parameters

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

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.

Return type

VariableCollection

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchVariable

Variable PatchVariable(ctx, variableKey, variable, optional)

Update a variable by key

Required Parameters

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

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. |

Return type

Variable

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostVariables

Variable PostVariables(ctx, variable)

Create a variable

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
variable	Variable

Return type

Variable

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]