Preview

This product or feature is covered by the Pre-GA Offerings Terms of the Google Cloud Terms of Service. Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

See the supported connectors for Application Integration.

Call REST Endpoint task

The Call 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 the Call 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.

Authentication

To use this task, you might need to create an authentication profile. Application Integration uses an authentication profile to connect to an authentication endpoint for the REST API call. If your API does not require authentication, then the Authentication profile field in the task configuration pane can be left empty.

If you have not created an authentication profile before configuring an integration task, you can access the profile creation dialog by clicking + New authentication profile in the task configuration pane. For more information about creating authentication profiles, see Create a new authentication profile.

The Call REST Endpoint supports the following authentication types:

• Auth token
• Google OIDC ID Token
• JSON Web Token (JWT)
• OAuth 2.0 authorization code
• OAuth 2.0 client credentials
• OAuth 2.0 resource owner password credentials
• SSL/TLS client certification only
• Service account

Configure the Call REST Endpoint task

To configure the Call REST Endpoint task:

1. In the Google Cloud console, go to the Application Integration page.

   Go to Application Integration

2. In the navigation menu, click Integrations.

   The Integrations List page appears.

3. Select an existing integration or create a new integration by clicking Create integration.

   If you are creating a new integration:

   1. Enter a name and description in the Create Integration dialog.
   2. Select a Region for the integration from the list of supported regions.
   3. Click Create.

   This opens the integration in the integration designer.

4. In the integration designer navigation bar, click +Add a task/trigger > Tasks to view the list of available tasks.
5. Click and place the Call REST Endpoint element in the integration designer.
6. Click the Call REST Endpoint element on the designer to view the Call REST Endpoint task configuration pane.
7. Configure the displayed fields using the configuration properties of the task as detailed in the table below.

   Changes to the properties are saved automatically.

Configuration properties

The following table describes the configuration properties of the Call REST Endpoint task.

Property	Data type	Description
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: DELETE GET HEAD PATCH POST PUT
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: True : Calls the redirected URL if the Endpoint base URL is forwarded to another URL. False: Does not call the redirected URL if the Endpoint base URL is forwarded to another URL.
Task should fail on HTTP error	Boolean	Exception handling strategy when the REST API call fails. You can select any one of the values: True : Throws an exception False: Does not throw an exception. But returns the error code and the error message in the response.
Disable SSL validation	Boolean	SSL validation against the destination server. You can select any one of the values: True : Skips SSL validation for the destination server and proceeds with the REST API call. False: Validates the SSL certificate for the destination server before proceeding with the REST API call. If the destination server has an invalid SSL certificate, the task returns an error code in the HTTP response.
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 the Call REST Endpoint task, see Usage limits.

Retry on failure

You can configure various retry strategies to handle errors in a task. The retry strategies allow you to specify how to rerun the task or integration in case of an error. For more information, see Error handling strategies.