| Field Name | Description | Required | Notes |
|---|---|---|---|
Protocol |
Specifies whether to use HTTP or HTTPS. |
Yes |
If you select HTTPS, specify a TLS context for inbound traffic. |
Inbound TLS |
TLS Context used for the inbound traffic of HTTPS APIs |
No |
Configure a TLS Context for Omni Gateway before adding a TLS Context to your API. Only available on Omni 1.4.0+. |
Port |
Specifies the number to use if the displayed port is incorrect. |
No |
API instances can share the same port across the same target if the Base path is different for both instances. Only available on Omni 1.2.0+. |
Base path |
Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash |
Yes |
|
Instance label |
Specifies a label for the API. |
No |
If you have multiple managed instances of the same API, add a label to differentiate each instance from the others. |
Advanced Options |
|||
Consumer endpoint |
Specifies a proxy application’s address for consumers to use for sending requests. |
No |
|
Manual Approval |
Enables manual approval for API Requests. |
No |
After submitting the instance, you must go to Contracts to approve or revoke the request. |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Base path |
Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash |
Yes |
|
Client provider |
Specifies a client provider for the API. |
No |
Anypoint Platform acts as the client provider by default. To configure an external client provider, see Client Providers. |
Instance label |
Specifies a label for the API. |
No |
If you have multiple managed instances of the same API, add a label to differentiate each instance from the others. |
Advanced Options |
|||
Consumer endpoint |
Specifies a proxy application’s address for consumers to use for sending requests. |
No |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Protocol |
Specifies whether to use HTTP or HTTPS. |
Yes |
If you select HTTPS, specify a TLS context for inbound traffic. |
Inbound TLS |
TLS Context used for the inbound HTTPS traffic. |
No |
Configure a TLS Context for Omni Gateway before adding a TLS Context to your server. |
Port |
Specifies the number to use if the displayed port is incorrect. |
No |
Instances can share the same port across the same target if the Base path is different for both instances. |
Base path |
Specifies the URL prefix for all server paths, relative to the host root. It must start with a leading slash |
Yes |
|
Instance label |
Specifies a label for the instance. |
No |
If you have multiple managed instances of the same asset, add a label to differentiate each instance from the others. |
Advanced Options |
|||
Consumer endpoint |
Specifies a proxy application’s address for consumers to use for sending requests. |
No |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Base path |
Specifies the URL prefix for all instance paths, relative to the host root. It must start with a leading slash |
Yes |
|
Client provider |
Specifies a client provider for the instance. |
No |
Anypoint Platform acts as the client provider by default. To configure an external client provider, see Client Providers. |
Instance label |
Specifies a label for the instance. |
No |
If you have multiple managed instances of the same asset, add a label to differentiate each instance from the others. |
Advanced Options |
|||
Consumer endpoint |
Specifies a proxy application’s address for consumers to use for sending requests. |
No |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Upstream URL |
URL to access for the proxy or API. This must end with a |
Yes |
For example, you can use the URL of your API asset in Exchange. |
Outbound TLS |
TLS Context used for the outbound traffic to the upstream service |
No |
Configure a TLS Context for Omni Gateway before adding a TLS Context to your API. Only available on Omni 1.4.0+. |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Upstream URL |
URL to access for the upstream service. This must end with a |
Yes |
For example, you can use the URL of your asset in Exchange. |
Outbound TLS |
TLS Context used for the outbound traffic to the upstream service |
No |
Configure a TLS Context for Omni Gateway before adding a TLS Context to your server. |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Instance label |
Specifies a label for the API. |
No |
If you have multiple managed instances of the same API, add a label to differentiate each instance from the others. |
Advanced Options |
|||
Consumer endpoint |
Specifies a proxy application’s address for consumers to use for sending requests. |
No |
|
Client provider |
Specifies a client provider for the API. |
Yes |
Anypoint Platform acts as the client provider by default. To configure an external client provider, see Client Providers. |
Manual Approval |
Enables manual approval for API Requests. |
No |
After submitting the instance, you must go to Contracts to approve or revoke the request. |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Upstream URL |
The URL to access for the proxy or the API. |
No |
For example, you can use the URL of your API asset in Exchange. |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Protocol |
Specifies whether to use HTTP or HTTPS for the validations. |
Yes |
If you select HTTPS, specify a TLS context for inbound traffic. |
Inbound TLS |
Specifies the TLS context to secure inbound traffic. |
No |
Only available on Mule 4+. If you can’t see a context, ensure that you have the correct permissions. To enable HTTPS in Mule 3 environment, see enable HTTPS in Mule 3x. |
Port |
Specifies the number to use if the displayed port is incorrect. |
Yes |
|
Base path |
Specifies the URL prefix for all API paths, relative to the host root. It must start and end with a leading slash |
Yes |
|
Instance label |
Specifies a label for the API. |
No |
If you have multiple managed instances of the same API, add a label to differentiate each instance from the others. |
Advanced Options |
|||
Consumer endpoint |
Specifies a proxy application’s address for consumers to use for sending requests. |
No |
|
Client provider |
Specifies a client provider for the API. |
Yes |
Anypoint Platform acts as the client provider by default. To configure an external client provider, see Client Providers. |
Request timeout |
Specifies the duration after which a request times out. |
No |
|
Proxy Version |
Specifies the version of the proxy to use for the endpoint. |
No |
|
Service Name |
Name of your WSDL service. |
Yes |
Only avaliable for WSDL APIs. |
Service Port |
Port for your WSDL your service. |
Yes |
Only avaliable for WSDL APIs. |
Service Namespace |
Namespace of your WSDL service. |
Yes |
Only avaliable for WSDL APIs. |
Enable Console |
Specifies whether you can expose and test your API specification. |
No |
You can specify a different path in Console Path, for example, |
Validations |
Specifies whether to validate inbound requests against a provided specification. |
No |
Only available if you have an attached API definition. Only available on Mule 3+. |
Strict validations (optional) |
Specifies whether to validate inbound requests against query parameters. |
No |
Only available if you have an attached API definition. Only available on Mule 3+ |
User Domain |
Specifies whether to use an API gateway domain. |
No |
If you chose Hybrid as the proxy deployment target previously in the configuration, ensure that you select this option. You must install the API gateway domain in Mule 3.8 and later. |
| Field Name | Description | Required | Notes |
|---|---|---|---|
Upstream URL |
The URL to access for the proxy or the API. |
Yes |
For example, you can use the URL of your API asset in Exchange. |
Outbound TLS |
Specifies the TLS context to secure outbound traffic. |
No |
Only available on Mule 4+. If you can’t see a context, ensure that you have the correct permissions. |