README.md

v4 Message API Entrypoints

Overview

{% hint style="warning" %} Enterprise only

As of Gravitee 4.1, the ability to create APIs with message API entrypoints is an Enterprise Edition capability. To learn more about Gravitee Enterprise Edition and what's included in various enterprise packages, please:

• Refer to the EE vs OSS documentation
• Book a demo
• Check out the pricing page {% endhint %}

v4 APIs support the following entrypoints:

• HTTP GET: Exposes a backend resource via the HTTP GET method
• HTTP POST: Exposes a backend resource via the HTTP POST method
• WebSocket: Exposes a backend resource via a WebSocket stream
• Webhook: Exposes a backend resource via a Webhooks subscription
• Server-sent events (SSE): Exposes a backend resource via a unidirectional SSE stream

Configuration

To access entrypoint configuration, go to the API page in the Developer Portal and select your API. Then, under Entrypoints, select General.

Here, you can choose to enable or disable virtual hosts. Enabling virtual hosts requires you to define your virtual host and optionally enable override access.

v4 message API entrypoint configuration

Next, depending on which entrypoint(s) your API utilizes, specific entrypoint configuration may differ. Click on the tiles below for the configuration details of each specific entrypoint.

	HTTP GET		http-get.md
	HTTP POST		http-post.md
	WebSocket		websocket.md
	Webhook		webhook.md
	Server-sent events		server-sent-events.md

You can also add an entrypoint to your API by clicking Add an entrypoint. From here, you must configure the entrypoint using the details specific to that entrypoint (see expandable sections above).

When you are done configuring your entrypoints, make sure to select Save changes.

{% hint style="info" %} For more detailed information on Gravitee entrypoints, see the Entrypoint Reference documentation. {% endhint %}