SSIS REST API Task
Send and receive data over HTTP(S) from your SSIS control flow.
Call REST-style web services with GET, POST, PUT and more. Save the response to a file or variable, filter it with JSONPath or XPath, validate status code and content, and connect with Basic or OAuth 2.0 authorization, all without coding.
The trial includes REST API Task and every other PowerPack component
- Easy test UI: see request and response
- Runs in your environment
- Also runs in Azure Data Factory
- OAuth, client certificate, TLS 1.2

At a glance
What REST API Task can do
REST API Task sends and receives data using HTTP(S) web requests such as GET, POST, and PUT. You can validate the web response and save it to a file or variable. To load API data as a table, use JSON Source instead.
Call any REST endpoint
Call REST-style HTTP(S) web services from SSIS.
- GET, POST, PUT, and other methods
- URL from a connection or a direct URL
- Custom headers and request body
Authentication
Windows / Basic authentication, client certificate, and OAuth.
- Basic and OAuth 2.0 authorization
{{User::Creds,BASE64ENC}}to encode an Authorization header
Save & filter the response
Save the response to a variable or file.
- Filter JSON or XML with JSONPath or XPath (e.g. extract a Token property)
- Array item index in JSONPath (e.g.
[0].some_field) - Save the response status code to a variable
Validate the response
Validate the response code, content, or header.
- Fail the task if a condition is not true
- Status code, content, and header rules
Error handling
Advanced error handling.
- Continue on any error or on a specific status code
- Save an error flag to a variable
- Get response data on error
Files: upload & download
Upload and download files over HTTP.
- Multipart/form-data upload with a custom boundary
- Very large uploads in chunks with the Content-Range header
- Download large files with the binary option
Dynamic values
Variables anywhere in the header or request data.
- Format specifiers such as
{{User::MyDate,yyy-MM-dd}} - Cookies support
Advanced options
Tune performance and security.
- GZip compression and timeout
- SSL/TLS protocol selection (TLS 1.2 supported)
- Test UI to see the request and response
SQL Server 2012–2025 & ADF
Runs in your environment on SQL Server 2012–2025 and Azure-SSIS.
- SQL Server 2025, 2022, 2019, 2017, 2016, 2014, 2012 (32/64-bit)
- Azure Data Factory (SSIS IR)
- Design packages in Visual Studio 2017, 2019, 2022, or 2026
- Windows only (64-bit OS): Windows 7–11 or Windows Server 2012–2025
See all features
- Call REST-style HTTP(S) web services from SSIS (e.g. GET, POST) (read more)
- Windows / Basic authentication (pass credentials), client certificate, and OAuth
- Advanced error handling (save error flag, continue on a specific error or any error)
- File upload and REST API POST using multipart/form-data (read more)
- Download large files using the binary option
- Save the response to a variable or file
- Cookies support (read more)
- Filter JSON/XML responses using JSONPath or XPath (e.g. extract a Token property from the response)
- Validate the response for response code, content, or header
- Easy test UI (see request / response)
- Advanced options (GZip compression, timeout, SSL/TLS protocols; TLS 1.2 supported)
- Dynamic variable replacement with format specifiers anywhere in the header or request data (e.g.
{{User::MyVar}},{{User::MyDate,yyy-MM-dd}}) - BASE64ENC format specifier (e.g.
{{User::Creds,BASE64ENC}}) to encode an Authorization header - Upload very large files using the Content-Range header (split a large stream into chunks)
- Extract data from a JSON array response using an array item index in JSONPath (e.g.
[0].some_field) - Continue on error for a specific response status code (Error Handling tab)
- Custom boundary for multipart/form-data uploads
Support for SQL Server 2025, 2022, 2019, 2017, 2016, 2014, 2012 (32/64-bit) and Azure Data Factory
SQL Server 2012–2025
Four key tabs to configure
Request, response, validation, and errors.
Build the request, decide what to keep from the response, check it, and choose what happens when the call fails.
Build the web request.
Choose the URL access mode (URL from a connection or a direct URL), the HTTP request method, the body, the body content type, and HTTP headers. Use Test Request/Response to see the raw traffic.
- Placeholders such as
{{User::MyVar}}in headers and body - Body content types such as JSON (application/json)
- Optional body compression

Keep what comes back.
Set the response content type, an optional JSONPath or XPath filter, and save the response content to a variable or file. Response headers can be mapped to variables too.
- Save to variable or file
- Filter expression such as
$.value - Save the response status code

Fail the task when the response is wrong.
Validate the response for the following conditions: status code, response content, or header. The task fails if any condition is not true.
- Status code rule, e.g. = 200
- Content rule, e.g. = ALL GOOD
- Header key and value rule

Decide what a failure means.
Continue on any error, when the URL is missing (404), on a specific response status code, or when a specific string is found. Save an error flag to a variable to branch later.
- Continue on a specific status code such as 404
- Get response data on error
- Save error status flag to a variable

Inside the UI
Key settings, as they appear in SSDT.
Real screens from the REST API Task product page and help file. Step through them, or open any shot at full size.
Send data with the POST method
Pass request data and custom headers.
Example
Save one value from a JSON response, then check it.
From the settings shown on the REST API Task product page: filter the JSON response, save it to a variable, and validate the call.
-
Response settings
On the Response Settings tab.
Response content type : Json Save response content : checked Save Mode : Save to Variable Select Variable : User::response -
Response content filter
Filter
$.valueA JSONPath expression applied to the response before it is saved.
-
Validation rules
Rule Condition Validate for Status Code = 200 Validate for Content = ALL GOOD If any condition is not true, the task fails.
Settings as shown in the screenshots on the REST API Task product page. Property reference in the help file.
Articles
Worked examples that use REST API Task.
Compatibility and requirements
Designed to stay inside your SSIS runtime.
- SQL Server 2012 through 2025, 32-bit and 64-bit
- Windows only, 64-bit OS required. SQL Server Express and Web editions do not include SSIS
- Azure Data Factory SSIS Integration Runtime
- Self-hosted: credentials and data stay in your environment (external API calls still reach that service)
- Fully functional 30-day trial of SSIS PowerPack
FAQ
Questions teams ask before they drop REST API Task on the canvas.
When should I use REST API Task instead of JSON Source?
Use REST API Task to call a service and save the response to a file or variable. If you need API data in table format to load into SQL Server or another target, use JSON Source instead.
Can I extract a single value such as a token?
Yes. Filter a JSON or XML response with JSONPath or XPath (for example to extract a Token property) and save it to a variable.
How do I make the task fail on a bad response?
Use the Validation tab to check the response code, content, or header. The task fails if any condition is not true.
Can it continue when an API returns an error?
Yes. You can continue on any error or a specific status code, get response data on error, and save an error flag to a variable.
Can it upload or download files?
Yes. It supports multipart/form-data uploads, very large uploads using the Content-Range header, and large file downloads using the binary option.
Which SQL Server versions can I run it on?
SQL Server 2025, 2022, 2019, 2017, 2016, 2014, and 2012 (32- and 64-bit), plus Azure Data Factory with an SSIS Integration Runtime (packages must target SQL Server 2017). See Compatibility and requirements.
Where is the full property reference?
Open the REST API Task help file.
Start your free trial today
Install SSIS PowerPack and drag REST API Task onto the Control Flow.
Test the request in the UI before you run the package, with no coding required.
- Control Flow Task in SSISREST API Task appears in the toolbox after you install PowerPack.
- Fully functional 30-day trialSSIS PowerPack, running in your environment.
- Live supportHelp during your trial and after purchase.
Open Help FileBrowse all SSIS PowerPack tasks
New purchases may be eligible for refund review within 30 days. See the refund policy.
Talk to an engineer before or during your trial.