Creating, Editing and Deleting an Inbound Address

Creating a new inbound address

To register a new inbound address, click the Create Inbound Address button, represented by the + symbol on the bottom right corner of the Inbound Address screen.

The fields to be filled in vary according to your gateway type and the protocols you accept.

If you use the Open Banking add-on and want to create an inbound address for use in an Open Banking context, there is an extra field to check and some options are fixed. Go to this page to see about the creation form in that case.

Hybrid gateway

When the API Platform is deployed to a hybrid environment, the responsibility for communication security is the client’s. Therefore, regardless of the protocol supported, the user must only type in the inbound address and then reference it when registering the desired environment to deploy APIs. You can read more about this here.

The fields to fill in are:

Name: name identifying the address. It can be equal to the host address itself or something more descriptive.
Gateway Type: in this case, select Hybrid.
Protocol Type: protocol(s) you accept (HTTP; HTTPS; HTTP|HTTPS).
- If the protocol is HTTP, the option Support to Protocol v0.9/1.0 will be checked by default and can’t be unchecked. If the protocol is HTTPS or HTTP|HTTPS, the option will be unchecked by default but may be checked.
Host/Inbound Address: type here the address itself. It will be the host of environments where APIs are deployed.

For hybrid gateways, you don’t need to use DNS. You can insert an IP address or port.

SaaS gateway

For SaaS gateways, the fields you need to configure vary according to the types of protocol accepted.

HTTP

If the only protocol accepted is HTTP, this means that no TLS security will be applied. In this case, the user must only type in the address in DNS format and then reference it when registering the desired environment to deploy APIs. You can read more about this here.

The fields to fill in are:

Name: name identifying the address. It can be equal to the host address itself or something more descriptive.
Gateway Type: in this case, select SaaS.
Protocol Type: protocol you accept (select HTTP).
- The option Support to Protocol v0.9/1.0 will be checked by default and can’t be unchecked.
Host/Inbound Address: type here the address itself as a DNS name. It will be the host of environments where APIs are deployed.

HTTPS or HTTP|HTTPS

When you accept only HTTPS or both HTTP and HTTPS (HTTP|HTTPS), you can choose the type of security applied: TLS or mTLS.

The TLS option means that the identity of the server is guaranteed, with a certificate being sent from the gateway to the client, but the client doesn’t need to send a certificate for authentication. In turn, when mTLS is applied, the client (that is, the application that will access the inbound address) must also inform a valid certificate when making requests.

In both cases, you must select a certificate that has already been registered on the Certificates screen. It must be an inbound certificate (that is, the inbound certificate option must be flagged when registering it). You can see more about registering certificates aqui.

In addition to the security options, the user must type in the host address in DNS format and then reference it when registering the desired environment to deploy APIs. You can read more about this here.

The fields to fill in are the same regarding HTTPS and HTTP|HTTPS:

Name: name identifying the address. It can be equal to the host address itself or something more descriptive.
Gateway Type: in this case, select SaaS.
Protocol Type: protocol you accept (select HTTPS or HTTP|HTTPS).
- The option Support to Protocol v0.9/1.0 will be unchecked by default and may be checked.
Host/Inbound Address: type here the address itself as a DNS name. It will be the host of environments where APIs are deployed.
Security: security type (TLS or mTLS)
TLS Version: two fields to define the range of TLS versions supported. Options: versions 1.0, 1.1, 1.2 e 1.3.
- The Min field must contain the lowest version supported while Max must contain the highest. Thus, if you choose 1.0 and 1.3, it means you support all version (from 1.0 to 1.3). If you choose 1.2 and 1.3, you support only versions 1.2 and 1.3. To support only one version, select it on both fields (e.g., 1.3, 1.3). The version on the Min field can’t be higher than that on the Max field.

For the sake of simplification, we are calling all versions "TLS version", but the official terminology is SSL 1.0 and 1.1 and TLS 1.2 and 1.3. It’s worth noting that mTLS is only applicable to TLS versions 1.2 and 1.3 (versions 1.0 and 1.1 are obsolete).

Certificate: field to select a certificate that is registered on the Certificates screen.
- It must be an inbound certificate.

Editing an inbound address

You can edit an inbound address listed on the Inbound Address screen.

Click the icon edit icon on the Actions column and you’ll be redirected to the editing screen, which is like the registration screen.

Any modification will be reflected on all environments that have the given inbound address as the host.

Deleting an inbound address

To delete an inbound address, click the icon delete icon on the Actions column of the list of existing addresses and click Confirm.

An inbound address can’t be deleted if it’s being used as the host of an environment.

Thanks for your feedback!

EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]