Info: Configuring custom domains is an optional step.
You can bind a custom domain name to allow API calls. Custom domain example:
Using custom domains in API Gateway is possible in the following ways:
If you don't need to use the custom domain, you don't need to provide anything for customDomains. In the IONOS API Gateway, a public endpoint is automatically provided for your API instance upon creation.
If you want to use the custom domain but with the IONOS TLS, you only need to provide the name in customDomains and make a CNAME record of your custom domain (name) to the given API Gateway public endpoint.
If you want to use the custom domain and your own TLS certificate, you must provide the name and certificateId. This certificateId is the ID of the certificate that you have created at IONOS Certificate Manager Service API (1.0) or Certificate Manager Service API (2.0).
Note: You can create up to five custom domains only.
Users need appropriate privileges to access, create, and modify API Gateways. Without necessary privileges, users do not have any access and cannot provision changes. You can grant appropriate privileges via the User Manager.
To allow users to access, create, and modify the API Gateway, follow these steps:
Log in to the DCD with your username and password.
In the DCD menu, select Management > Users & Groups under Users.
Select the Groups tab in the User Manager window.
Select the appropriate group to assign relevant privileges.
In the Privileges tab, select Access and manage API Gateway to allow the associated group members to access and manage API Gateway.
Note: You can remove the privileges from the group by clearing Access and manage API Gateway.
Result: Appropriate privilege is granted to the group and the users in the respective group.
For improved user management and delegation, you can establish sub-users and grant them the necessary permissions to use the API Gateway. Sub-users can be given varying levels of access for their segment of the logging pipeline by the primary account owners. Only the pipelines that the primary account owner has assigned to sub-users are visible to them and can be managed, but they cannot access the primary account or pipelines created by other sub-users.
To create sub-users, follow these steps:
Log in to the DCD with your username and password.
In the DCD menu, select Management > Users & Groups under Users.
Select the Groups tab in the User Manager window.
Select the appropriate group to assign relevant privileges.
In the Members tab, click + Add User and select a user(s) from the list.
To delete an associated sub-user, click Remove User.
Result: A sub-user(s) is created.
To create an API Instance, follow these steps:
Log in to the DCD with your username and password.
Go to Menu > Management > API Gateway.
Choose Create API Instance.
Enter the following details in the Properties:
Name: Provide an appropriate name.
Region: Enter the location Germany/Berlin. Please note that the API Gateway is available only in Berlin.
Logs: Activate the logs
Metrics: Activate the metrics
Optional: Custom Domains
Domain name: Enter a domain name.
Choose a SSL certificate. For more information, see Manage SSL Certificates.
Click Create.
Note!: Please note that activating Logs and Metrics will incur additional costs.
You can add new instances and edit the existing ones.
To delete an API Instance, follow these steps:
Go to Menu > Management > API Gateway.
In the list of your instances, choose the one you want to delete and click in the OPTIONS column.
Select Delete instance in the dialog box.
Choose Delete in the window.
Result: The selected instance will be deleted.
Once you have created an API instance in the API Gateway, the next step is adding and editing routes to define how your API handles incoming requests.
Go to Menu > Management > API Gateway.
In the list of your created instances choose one instance and go to OPTIONS - Edit routes.
Enter the following details in the Routes window:
Route Properties:
Route name: Provide an appropriate name.
Path: Define the endpoint for the route.
Methods: Choose the HTTP method (GET, POST, PUT, DELETE) the route will support.
Web Socket: on/off
Protocol: HTTP
Upstreams:
Note:
You should add at least one upstream to your route.
The hostname must be publicly accessible and RFC 1123 compatible.
Host: Enter IP or public URL
Load balancer Algorithm: Choose between roundrobin and least_connections
Weight (optional)
Scheme: Choose a scheme, such as HTTPS, GRPC, etc.
Port
Click Save to create the route.
Result: Your route is now created. You can now add new routes and edit the existing ones.
You can create a Gateway instance from the DCD and configure routes and upstreams. In the DCD, go to Menu > Management > API Gateway. In the DCD, you can manage your API instances, set up custom domains, and configure routes and upstreams.
Learn how to create an API instance.
Learn how to create custom domains.
Learn how to configure routes and upstreams.
Learn how to configure routes and upstreams.
