Variables

A variable is a value that can be applied on certain parameters of a request. Instead of typing the same value repeatedly across many requests, you can use a variable for that, saving effort if you need to change this value - only change the variable's value where it is defined, in a single place.

There are two classes of variables: collection variables and environment variables.

Collection variables

Collection variables are available to be used in every request of the collection. To view the collection variables, click on the collection Variables in the left panel.

Environment variables

Environment variables are also available for every request of the collection, however, they will only be considered for usage if the environment is active / current. To view the environment variables, click on the environment in the left panel.

Editing variables

You can add a new variable by clicking on the "+" button, at the top left. To edit a variable, double-click a field of the variable on the grid and enter text.

To move your variables, click, hold and drag the "::" symbol at the left of the row and drag to where you want to place your variable.

To remove a variable, click on the "X" mark of its row, at the right, on the grid.

A variable can be enabled or disabled. Only enabled variables will be considered for resolution.

Variables marked as secret allow for better control of sensitive data when exporting your collection or environment. Read more on the Export and Import page.

How to use a variable

Variables can be used for the following fields of a request:

• URL
• HTTP headers' names and values
• Custom auth parameters
• HTTP request
  • Raw body: content
  • File body: file source path
  • Form URL encoded body: parameters' names and values
  • Multipart form data body: parameters' names and values, including file source paths
  • GraphQL body: variables content
• WebSocket message
  • Raw body: content
  • File body: file source path
• HTTP repeater
  • Raw input data
  • Input data file source path

To use a variable, type {{VariableName}} on the field you want to apply it.

For example: if a request URL is {{BaseUrl}}/index.html and there is a variable named BaseUrl with the value http://www.pudim.com.br, when sending the request, the resolved URL will be http://www.pudim.com.br/index.html.

For request URLs, you can hover over the URL text box and preview the resolved URL.

The image below shows how to use a variable in a raw body's content. In it, {{VariableName}} will appear highlighted in yellow.

Variable resolution logic

The resolution logic is as follows:

1. Only enabled variables are considered.
2. Collection variables will be joined with the current environment variables. If no environment is active, then only collection variables.
3. Environment variables have precedence - if there are two variables declared with the same name both in the collection and in the environment, the environment variable will be preferred.
4. Every request field that allows the usage of variables will be checked for whether it has a variable template, for example, {{VARIABLE_NAME}}. If the template is found and there is an enabled variable for it, the variable's value will be applied. Otherwise, the template will remain in the text field.

Capturing response into variables

Read more here.