HTTPS Connections

Atlas Stream Processing supports source connections over HTTPS.

Add an HTTPS Connection

To add an HTTPS connection to your Stream Processing Instance:

Create a config.json file.

{
   "name": "ExampleHTTPSConnection",
   "type": "Https",
}

Create the HTTPS connection.

Run the following Atlas CLI comand to create the conection:

atlas streams connections create -i <instance-name> -f </path/to/config.json>

Navigate to your stream processor.

Select the Stream Processing tab in the left sidebar menu in the Atlas UI.

Configure your stream processor connection.

Click the Configure button for your selected stream processor.
Select the Connection Registry tab.
Click the Add Connection button.
Select HTTPS from the Connection Type dropdown menu.
Name your new connection.
Populate the URL input field with the URL your stream processor will make requests to.
Add any required headers to be sent with the HTTPS request, such as the data type or authentication credentials required by the external API.
Click the Create Connection button to create the connection.

The Atlas Administration API provides an endpoint for adding a connection to a connection registry.

Create One Connection

If the API endpoint requires authentication, such as an API key or Bearer Access Token authentication, you should add authentication details as headers when you define the connection to prevent providing these as plaintext as part of the $https operator.

Other authentication schemes, such as Digest Auth or OAuth, are not currently supported.

To learn how to use HTTPS connections with Atlas Stream Processing, see $https Stage (Stream Processing).

Example:

curl --user "<publicApiKey>:<privateApiKey>" --digest \
  --header "Content-Type: application/json" \
  --header "Accept: application/vnd.atlas.2023-02-01+json" \
  --include \
  --data '{"name": "HTTPSConnection","type": "Https","url": "<apiBasePath>"}' \
  --request POST "https://cloud.mongodb.com/api/atlas/v2/groups/<projectID>/streams/<tenantName>/connections"

Back

Atlas Connections

S3 Connections