How to Use Environment Variables for Secure Storage

1. Obtain APImetrics API Key

To create an APImetrics API Key, follow the instructions on the APImetrics API Overview page.

2. Add Environment Variables

To add your environment variable:

1. Go to Project Settings > Environment Variables (from left-hand navigation bar).
2. Make sure you're in your desired workspace (the default is "global").
3. Click + Add Property.
4. Give your variable a name and enter some placeholder text in the value field (e.g., "SampleText").
5. Click Save.

3. Assign a Value to an Environment Variable

Use the following API : Set Environment Variable to store the value to the Environment Variable created in last step.

1. Fill in the Path Parameters:
   1. Workspace: (defaults to global)
   2. Variable_name: (use the same name created in Step 2.4)
2. Pass the new value in the request body using JSON format:

{ 
  "value": "Enter-your-Environment-variable-value" 
}

3. Select the Authentication settings:
   1. Choose Authentication Setting: APImetrics API
   2. Use the Token you created in Step 1.
      
      

Executing this API call will update the environment variable with the new value.

4. Retrieve an Environment Variable value

Use the following API : Get Environment Variable to retrieve the value of an Environment Variable.

1. Fill in the Path Parameters:
   1. Workspace: The name of your workspace (e.g., "global").
   2. Variable_name: The name of the environment variable you want to retrieve.
2. Select the Authentication settings:
   1. Choose Authentication Setting: APImetrics API
   2. Use the Token you created in Step 1.
      
      

This API call returns the value of the specified environment variable in JSON format.

The response will have the following structure:

JSON

> "workspace_variable": {  
>     "name": <string>,  
>     "value": <string>  
>   }

📘

You can automate the secure storage and retrieval of your tokens and other sensitive values by incorporating the Set Environment Variable and Get Environment Variable API endpoints into your workflows.