Call REST Endpoint task
TheCall REST Endpoint task lets you call any third-party REST API from your integration. The response from the REST API call will be available to you in an integration variable and can be used in other down-stream tasks.
Note:- The network configuration of theCall REST Endpoint task allows it to call endpoints only available over the public internet. Hence, the task can't connect to hosts or IPs that reside only within a private network such as a VPC, even if that VPC is peered with your other Google Cloud services such as Apigee X.
- This task can process a maximum of 50 MB of REST response.
Before you begin
- To connect to an authentication endpoint for the REST API call, ensure that you have eithercreated an OAuth 2.0 profile orattached a user-managed service account to your integration. If your API does not require authentication, then theAuthentication profile field in the task configuration pane can be left empty. To see a list of configurations, seeConfiguration properties.
If your integration has both OAuth 2.0 profile and a user-managed service account configured, then by default the OAuth 2.0 profile is used for authentication. If neither OAuth 2.0 profile nor user-managed service account is configured, then the execution fails.
- If your integration has a service account attached, then based on the REST endpoint URL, grant the required IAM role to that service account. For example, if your REST endpoint URL calls a Cloud Storage service, then grant the required IAM role for the Cloud Storage service.
For information about granting roles to a service account, seeManage access to service accounts.
- Ensure thatVPC Service Controls isNOT setup for Application Integration in your Google Cloud project.Warning:Cloud Function does not function or stops functioning ifVPC Service Controls is setup for Application Integration in your Google Cloud project.
Configure the Call REST Endpoint task
To configure theCall REST Endpoint task:
- In the Google Cloud console, go to theApplication Integration page.
- In the navigation menu, clickIntegrations.
TheIntegrations page appears listing all the integrations available in the Google Cloud project.
- Select an existing integration or clickCreate integration to create a new one.
If you are creating a new integration:
- Enter a name and description in theCreate Integration pane.
- Select a region for the integration.Note: TheRegions dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, clickEnable Region. SeeEnable new region for more information.
- Select a service account for the integration. You can change or update the service account details of an integration any time from theIntegration summary pane in the integration toolbar.Note: The option to select a service account is displayed only if you have enabled integration governance for the selected region.
- ClickCreate. The newly created integration opens in theintegration editor.
- In theintegration editor navigation bar, clickTasks to view the list of available tasks and connectors.
- Click and place theCall REST Endpoint element in the integration editor.
- Click theCall REST Endpoint element on the designer to view theCall REST Endpoint task configuration pane.
- Configure the displayed fields using theconfiguration properties of the task as detailed in the table below.
Changes to the properties are saved automatically.
Note: If you update the authentication profile for aCall REST Endpoint task, and test the integration without publishing the changes, the integration uses the old authentication profile. To ensure that the integration uses the updated authentication profile, you mustpublish the integration before testing.
Configuration properties
The following table describes the configuration properties of theCall REST Endpoint task.
| Property | Data type | Description |
| Label | String | Optional: add a label for your task. |
| Authentication | String | Optional: configures and stores the authentication details for connections to external systems. For more information, seeCreate authentication profiles in Application Integration. |
| Endpoint base URL | String | REST endpoint URL without the query parameters. |
| HTTP method | NA | HTTP method to use. You can select any of the following HTTP methods:
|
| URL query string parameters | Query string key :String Value:String | Query parameters required for the REST API call. The query parameters are in the form of key-value pairs where key is the key name and the value is the corresponding key value. You can enter more than one key-value pair by clicking on the plus icon. |
| HTTP headers | HTTP header key:String Value:String | HTTP headers required for the REST API call. The HTTP headers are in the form of key-value pairs where key is the key name and the value is the corresponding key value. You can enter more than one key-value pair by clicking on the plus icon. |
| Follow redirects | Boolean | Follow URL redirects. You can select any one of the values:
|
| Task should fail on HTTP error | Boolean | Exception handling strategy when the REST API call fails. TheCall REST Endpoint fails if the HTTP response code is4xx or5xx. For a list of error codes, seeError codes. For other HTTP response codes, return error code and error message in the response.Note: For errors that are not related to REST API call, such as incorrect URL, the task always fail irrespective of what this option is set to.You can select any one of the values:
|
| Response header (<Task name>) | String | Uncompressed response header from the REST APIs response. |
| Response body (<Task name>) | String | Uncompressed response body from the REST APIs response. |
| Response status (<Task name>) | String | HTTP response code and the corresponding code text from the REST APIs response. |
Best practices
For information about the usage limits that apply to theCall REST Endpoint task, see Usage limits.
Error handling strategy
An error handling strategy for a task specifies the action to take if the task fails due to atemporary error. For information about how to use an error handling strategy, and to know about the different types of error handling strategies, seeError handling strategies.
To learn how to handle retry strategies for4xx or5xx errors, see theHow to retry Rest Caller Task based on Response Status blog.
Quotas and limits
For information about quotas and limits, seeQuotas and limits.
What's next
- Learn aboutall tasks and triggers.
- Learn how totest and publish an integration.
- Learn abouterror handling.
- Learn aboutintegration execution logs.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-19 UTC.