SSIS tutorial: How to use variables inside API source/destination

Tutorials SSIS Tutorials
, ,
1

Introduction

API Source and API Destination components support SSIS variables the same way API Connection Managers do, using {{User::VariableName}} syntax. This lets you set parameters (headers, query string values, request body fields, etc.) dynamically at runtime instead of hardcoding them, without needing to move that configuration into the Connection Manager. This article explains how to insert variables directly into the parameters of an API Source or Destination component.

Prerequisites

Steps

  1. Open the API Source or API Destination component editor.
  2. Go to the parameter grid, click Raw Edit to open the full parameters editor.
  3. Use the Insert Variable button to pick an existing SSIS variable, or type the variable reference directly using the format:
{{User::VariableName}}
  1. If the value needs to be safely encoded for JSON (e.g., to avoid breaking the request when the variable contains quotes or special characters), append the JSONENC modifier:
{{User::VariableName,JSONENC}}

image
image888×655 51.7 KB

  1. Click OK to save the parameter configuration.
  2. Use Preview Data to confirm the request runs correctly with the variable’s current value.
  3. If you want to use expressions inside the component, this article can help you.

Conclusion

API Source and API Destination components accept the same {{User::VariableName}} syntax used in API Connection Managers, so any parameter (required or optional) can be set dynamically at runtime. Using Insert Variable or Raw Edit, along with the JSONENC modifier when needed, enables driving requests entirely from SSIS variables rather than hardcoded values.

Still need help?

If you need assistance using variables in your API Source or Destination component, please contact our support team: