Adding a request header

GET {{base_url}}/collections

Under the Headers tab, add a Key and Value for Qodex to send as headers. For example, the [Qodex API] allows you to add an x-api-key request header. Create an environment variable with the value of your Qodex API key, and hit Send.

Note: these headers are included in the [Qodex documentation] rendered in the web, but the auto-generated headers and params shown in the previous request are not. If you want to be explicit in the documentation, then add headers as shown in this example.

Keep your environment variable private

Remember, if you're [sharing the environment] with your team in a team workspace, use the environment's initial value to share data with the team. Use the environment's current value to restrict this data to your session within the Qodex app.

Final check before publishing documentation

If you plan to publish collection and environment, you can [preview the documentation] Qodex will warn you about anything that appears to be a sensitive token. For example, if you accidentally put your Qodex API key in the initial value (instead of current value), Qodex will highlight those secrets in the live preview.

HEADERS