When working with API Gateway, gRPC and WebSocket are two different communication protocols that serve distinct purposes.

WebSocket is suitable for real-time applications like chat apps or live data streaming. API Gateway's WebSocket APIs provide a managed solution for handling WebSocket connections and routing messages to backend services.

When using the IONOS API Gateway to set up a WebSocket API, you can create routes to handle different types of WebSocket events, such as connecting, disconnecting, and sending messages:

• Connect: This route is triggered when you connect to the WebSocket API.

• Disconnect: This route is activated when you disconnect from the WebSocket API.

• Custom Routes: You can define custom routes for specific actions your WebSocket API should handle, for example, /sendMessage for sending messages between users.

API Gateway provides the following features and benefits:

• Multi-Protocol Support: The API Gateway supports various protocols, including HTTP, HTTPS, WebSocket, gRPC, and gRPCS, allowing you to expose APIs built with different technologies.

• Load Balancing: Distribute incoming traffic efficiently across your backend services using round-robin with weights or least connection algorithms.

• Flexible Routing: Route API requests to the appropriate backend service based on specific patterns within the URL path or query parameters.

• API Observability: Access comprehensive logs to monitor API activity and troubleshoot any issues.

• Metrics and Logs Collection: Obtain detailed metrics directly from the API Gateway to gain insights into API performance, resource utilization, and logs.

• Traffic Control: By managing API traffic, API Gateways help control the rate of requests, enforce rate limiting, and optimize resource utilization, ensuring efficient handling of incoming requests.

• Monitoring: API Gateways offer monitoring and analytics capabilities to track API operation, performance criteria, and error rates. This data helps dissect and optimize API operations for better performance and trustability.

• Version Control: API Gateways support versioning and lifecycle management of APIs, enabling smooth transitions between versions, backward compatibility, and centralized control over API changes.

• Integration with Backend Services: API Gateways facilitate seamless integration with backend services, databases, cloud resources, and external systems, streamlining communication and data exchange within the system.

Based on IONOS API Gateway features and benefits, the following use cases are derived that meet your business demands:

• Routing Requests to Appropriate Backend Services: By routing requests to the appropriate backend services, API Gateways ensure that incoming API requests are directed to the correct destinations, enabling efficient communication and seamless interaction between clients and backend systems.

• Managing and Securing API Access: This will be supported in later versions.

• Monitoring and Logging API Traffic: By actively monitoring and logging API traffic within an API Gateway, you can enhance operational visibility, ensure system reliability, optimize performance, and promptly address issues to deliver a seamless and secure API experience.

• Serverless Applications: Offering a flexible and efficient way to build and manage APIs in a cloud-native environment. By leveraging the benefits of serverless computing, you can focus on developing your application logic.

• Legacy System Modernization: API gateways can expose legacy systems as modern APIs. This allows newer applications to interact with older systems without requiring extensive modifications to the legacy codebase.

• Mobile and Web Applications: API Gateways provide a secure and scalable way to handle API requests from mobile and web applications. They can also implement features like rate limiting and caching, which can improve their performance.

• Internet of Things (IoT): API Gateways can manage many API requests generated by IoT devices and implement security measures to protect them from unauthorized access.

• B2B Integrations: It is possible to facilitate secure and reliable business communication. API Gateways can be used to manage access to APIs, enforce security policies, and monitor API usage.

• Transforming API Protocols and Data Formats: API Gateways can mediate between protocols (for example, REST to SOAP) and data formats, enabling seamless communication between diverse systems. Static Web Hosting: Using IONOS Object Storage for static web hosting with an API Gateway involves allowing your API Gateway to serve or interact with the static content stored in an IONOS Object Storage bucket.

You can bind a custom domain name to allow API calls. Custom domain example:

{
 "metadata": {},
 "properties": {
 "name": "APIGateway-1",
 "logs": false,
 "metrics": false,
 "customDomains": [
 {
 "name": "api.example.com",
 "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
 }
 ]
 }
}

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).

To delete the specified Gateway, you need to use the following DELETE request:

DELETE /gateways/{apigatewayId}

Request

curl -X 'DELETE' \
  'https://apigateway.de-txl.ionos.com/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00' \
  -H 'accept: application/json'

Response

202 Deleting Gateway was successful

The command ensures the Gateway with the provided ID is created or modified. The full Gateway must be provided to ensure (either update or create) the Gateway. Non-present data will only be filled with defaults or left empty, but previous values will not be taken into consideration.

To ensure the Gateway, you need to use the following PUT request:

PUT /gateways/{apigatewayId}

Request

curl -X 'PUT' \
  'https://apigateway.de-txl.ionos.com/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "metadata": {},
  "properties": {
    "name": "APIGateway 1",
    "logs": false,
    "metrics": false,
    "customDomains": [
      {
        "name": "api.example.com",
        "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
      }
    ]
  }
}'

Response

200 Gateway successfully updated

{
  "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "type": "gateway",
  "href": "/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "john.doe@example.com",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "john.doe@example.com",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "publicEndpoint": "jf8u4tgr73sd-ag.87uhr654gq90.apigateway.de-txl.ionos.com"
  },
  "properties": {
    "name": "APIGateway 1",
    "logs": false,
    "metrics": false,
    "customDomains": [
      {
        "name": "api.example.com",
        "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
      }
    ]
  }
}

201 Gateway successfully ensured

{
  "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "type": "gateway",
  "href": "/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "john.doe@example.com",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "john.doe@example.com",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "publicEndpoint": "jf8u4tgr73sd-ag.87uhr654gq90.apigateway.de-txl.ionos.com"
  },
  "properties": {
    "name": "APIGateway 1",
    "logs": false,
    "metrics": false,
    "customDomains": [
      {
        "name": "api.example.com",
        "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
      }
    ]
  }
}

This section highlights the observability features of the API Gateway. The API Gateway currently supports metrics and logs. When enabled, all logs and metrics are transmitted to our observability system, where they can be queried and analyzed for valuable insights. Central logging must be enabled for this functionality, ensuring effective monitoring and troubleshooting of API traffic. This allows for proactive identification and resolution of potential issues, enhancing overall system performance and reliability.

Accessing Logs & Metrics

Once central logging is enabled, logs from your API Gateway will be sent to the logging service. You can access and analyze these logs and metrics using a dedicated Grafana instance.

Grafana Instance URL

The URL for your Grafana instance is automatically made available when your API is first created. You can retrieve this URL using a GET request from the API Gateway (specific API details will be provided in a separate section). By leveraging central logging and Grafana, you gain valuable insights into your API's performance, identify potential issues, and ensure optimal API health.

Enabling Central Logging

• Requirement: Enabling central logging is mandatory for the API Gateway to send logs.

• Configuration: Send a PUT request to the logging service endpoint to enable central logging. Here's an example using curl:

curl -X "PUT" "https://logging.de-txl.ionos.com/central" \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer TOKEN' \
     -d '{ "properties": { "enabled": true } }'

API Gateway is a regional service. To create an instance, you should send a POST request to the appropriate regional endpoint, e.g., Berlin https://apigateway.de-txl.ionos.com

Request

curl -X 'POST' \
  'https://apigateway.de-txl.ionos.com/gateways' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "metadata": {},
  "properties": {
    "name": "APIGateway 1",
    "logs": false,
    "metrics": false,
    "customDomains": [
      {
        "name": "api.example.com",
        "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
      }
    ]
  }
}'

Response

201 Gateway successfully created

{
  "id": "0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "type": "gateway",
  "href": "/gateways/0620c174-dd3c-5eb4-87c8-e2b516553a00",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "john.doe@example.com",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "john.doe@example.com",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "status": "AVAILABLE",
    "statusMessage": null,
    "publicEndpoint": "jf8u4tgr73sd-ag.87uhr654gq90.apigateway.de-txl.ionos.com"
  },
  "properties": {
    "name": "APIGateway 1",
    "logs": false,
    "metrics": false,
    "customDomains": [
      {
        "name": "api.example.com",
        "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
      }
    ]
  }
}

What is an API Gateway?

An API Gateway is a centralized service that acts as an entry point for APIs, providing security, rate limiting, routing, and monitoring features. It helps ensure secure and efficient communication between clients and backend services.

What are the key features of an API Gateway?

Key API Gateway features include API traffic management, protocol translation, load balancing, and a developer portal. These features provide efficient management of incoming requests, seamless communication between clients and backend services, increased productivity, and a better experience for developers.

How do API Gateways work?

API Gateways act as a buffer between clients and backend services. They can perform various complex operations, such as authentication, authorization, request transformation, response aggregation, and more, simplifying the communication process for clients and backend services. By analyzing request paths and applying routing rules, API Gateways ensure incoming requests are directed to the appropriate backend service or microservice within the ecosystem, enabling efficient request handling. API Gateways analyze backend service responses before relaying them to clients, allowing for additional processing, transformation, and data aggregation to optimize the response format and content for client consumption.

Is API Gateway a paid service?

Yes, the price depends on the number of requests and data transfers.

Can I use the API Gateway to monitor API performance?

Yes, the API Gateway in IONOS offers monitoring and analytics features that enable users to track API usage, performance metrics, and error rates and gain insights to identify performance bottlenecks and optimize API performance.

What should I do if an API request fails?

Check if the API service is running in your environment.

To create an API Instance, follow these steps:

1. Log in to the DCD with your username and password.

2. Go to Menu > Management > API Gateway.

1. Choose Create API Instance.

2. 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

1. Optional: Custom Domains

• Domain name: Enter a domain name.

• Choose a SSL certificate. For more information, see Manage SSL Certificates.

1. Click Create.

You can add new instances and edit the existing ones.

Delete Instance

To delete an API Instance, follow these steps:

1. Go to Menu > Management > API Gateway.

2. In the list of your instances, choose the one you want to delete and click in the OPTIONS column.

1. Select Delete instance in the dialog box.

2. Choose Delete in the window.

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:

1. Log in to the DCD with your username and password.

2. In the DCD menu, select Management > Users & Groups under Users.

3. Select the Groups tab in the User Manager window.

4. Select the appropriate group to assign relevant privileges.

5. In the Privileges tab, select Access and manage API Gateway to allow the associated group members to access and manage API Gateway.

Create and manage sub-users

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:

1. Log in to the DCD with your username and password.

2. In the DCD menu, select Management > Users & Groups under Users.

3. Select the Groups tab in the User Manager window.

4. Select the appropriate group to assign relevant privileges.

5. In the Members tab, click + Add User and select a user(s) from the list.

To delete an associated sub-user, click Remove User.

IONOS API Gateway APIs allow contract owners, administrators, and authenticated users with the required permissions to create and configure your API to manage routes, integrate backend services, and deploy your API.

Quick Links

To retrieve the Gateway, you need to use the following GET request:

GET /gateways/{apigatewayId}

Request

Response

201 Success

To retrieve the route, you need to use the following GET request:

GET /gateways/{apigatewayId}/routes/{routeId}

Request

Response

200 Success

The command ensures that the route with the provided ID is created or modified. The full route must be provided to ensure (either update or create) the route. Non-present data will only be filled with defaults or left empty, but previous values will not be taken into consideration.

To ensure the route, you need to use the following PUT request:

PUT /gateways/{apigatewayId}/routes/{routeId}

Request

Response

200 Route successfully updated

201 Route successfully ensured

API Gateway is a managed service that provides a centralized public entry point for API calls. It enables seamless integration and communication between services, applications, and clients. It is designed to simplify the process of creating, deploying, and managing APIs in a scalable and secure manner.

With the API Gateway, you can monitor API usage, track performance metrics, and generate logs for analysis and troubleshooting. With API Gateway, you can route incoming API requests to the appropriate backend services based on defined routing rules, ensuring efficient communication between clients and services.

You can use IONOS S3 for static web hosting as an upstream for an API Gateway, allowing you to read content stored in the S3 bucket.

API Gateway Access

You can access the API Gateway by using the DCD (a browser-based interface) or REST API Instructions for using the Console and API, which are included in topics throughout this documentation. For a list of available SDKs, see . For general information about using the API, see .

Limitations

To create the object, the full route needs to be provided. Optional data will be filled with defaults or left empty.

To create a new route, you need to use the following POST request:

POST /gateways/{apigatewayId}/routes

Request

Response

201 Route successfully created

API Gateway is a service that allows you to monitor API usage, track performance metrics, and generate logs for analysis and troubleshooting. API Gateway simplifies the process of creating and managing APIs by providing a fully managed service that handles the heavy lifting of infrastructure management. This allows you to focus on building and improving your APIs and services.

Product Overview

API Gateway

DCD How-Tos

API How-Tos

Developer Tools

API Gateway REST API

Frequently Asked Questions (FAQs)

To get answers to the most commonly encountered questions about API Gateway, see FAQs.

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.

Quick Links

To delete the specified route, you need to use the following DELETE request:

DELETE /gateways/{apigatewayId}/routes/{routeId}

Request

Response

202 Deleting Route was successful

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.

Edit Routes

1. Go to Menu > Management > API Gateway.

2. In the list of your created instances choose one instance and go to OPTIONS - Edit routes.

1. 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:

• 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

1. Click Save to create the route.