Configure a new API proxy endpoint ​

The Details tab summarizes settings from the following components in the proxy workflow:

View a proxy-based endpoint's Details tab

• New API proxy request trigger

• Defines the schema for incoming requests, including the content type, query parameters, body, headers, and the expected response schema.

• Forward request to target action

• By default, all proxy endpoints forward requests to the target API. If needed, you can transform incoming request data, such as headers, query parameters, and the request body, before forwarding it to the target API endpoint. Refer to the API proxy transformation guide to learn how to transform requests.

• Return response action

• Configures the response sent to the client, including the content type, headers, HTTP status codes, and body. You can also transform the response by modifying its data before sending it to the client.

If you created an endpoint manually or chose Manual configuration when creating the collection, you must configure the schema and headers. For more information, refer to Configure the schema.

If you imported an OpenAPI specification when you created the collection, the schema and headers for each endpoint are preconfigured.

The Target URL section displays the address that requests to the proxy endpoint are forwarded to. You can modify the target URL by modifying the associated HTTP connection in the API proxy collection settings.

The Test request tab enables you to test the proxy endpoint by sending sample requests and reviewing responses.

View a proxy-based endpoint's Test tab

This tab includes the following sections:

• Parameters

• Lists the required query parameters, headers, and request body for the endpoint.

• Responses

• Displays the expected HTTP status codes and response schema for the client.

The Settings tab allows you to update proxy endpoint details. For example, you can adjust the request timeout for specific API requirements or rename an endpoint for better organization.

View a proxy-based endpoint's Settings tab

The Settings tab includes the following fields:

• HTTP method

• Select the HTTP method to use for the endpoint.

• Endpoint name

• Enter a descriptive name for the endpoint.

• Endpoint path

• Enter the endpoint path, which can include path parameters. Ensure the endpoint path follows the endpoint path guidelines.

• Endpoint description

• Enter a description for the endpoint.

• Request timeout

• Enter the request timeout duration: 30 seconds (default), 240 seconds (maximum).

• Keep base URL

• Toggle whether to forward requests directly to the connection's base URL without appending the endpoint path.

• Cache response

• Click the Cache response toggle to enable caching. This option is available only for GET methods.

  • Time-to-live period

  • Required. Enter the duration in seconds for storing a response in the cache before it refreshes or deletes. The default value is 600 seconds and the maximum value is 3600 seconds.

  • Cache key parameters

  • Optional. Define additional parameters to include in the cache key if required. The cache key always starts with the endpoint URL. For more information, see API endpoint caching.

You can make changes directly in this tab and click Save to apply them.