Comment on page
HTTP API (Call an Osmos API)
There are two modes of operation for this connector. Either Osmos will call your API, or Osmos can generate an API for you to call. Put another way, either you have an API endpoint created, or you want Osmos to create an API endpoint for you. These two modes will be referred to as Osmos Calls Your API and Call an Osmos API respectively. This page is for the latter. To see documentation on the former, see HTTP API (Osmos Calls Your API).
This Destination Connector creates a secure API endpoint that you can send data to within Osmos. After sending data to this connector, you can retrieve (GET) data from the API endpoint outside of Osmos using the provided URL.
Step 1: After selecting + New Connector, under the System prompt, click HTTP API.
Step 2: Provide a Connector Name.
Step 3: Select Destination Connector.
Step 4: Select Call an Osmos API
1. Click Add Field for each additional field required in the schema. 2. Select Create Schema once you have built the schema.
An API endpoint has been created based on the schema built in the previous step.
You can send data to this API endpoint from a Source Connector within Osmos using an Osmos Pipeline. Following this, you can retrieve (GET) data from this API endpoint using the provided URL.
Note: Performing a retrieval (GET) from the Osmos API endpoint bypasses the standard Osmos batch write process, and so no record counts will be displayed in the Pipeline or Uploader management page.