HTTP API (Call an Osmos API)

Overview

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.

Creating an HTTP API Destination Connector

Step 1: Click New Connector.
Step 2: Under the System prompt, click HTTP API.
Step 3: Provide a Connector Name.
Step 4: Select Destination Connector.
Step 5: Select Call an Osmos API

Building the Schema for the API Endpoint

Parameter
Description
Field Name
Provide a field name for the output fields. These names will be used as the column names for the source data you send to this API.
Type
Define the type of each field. The field types will be used to enforce rules when you send data to this API.
Nullable
Check this box if the field is nullable. If the field is not nullable, you will be required to provide values for this field when sending data to this API.
Delete
Deletes the Field
Step 1: Click Add Field for each additional field required in the schema. Step 2: Select Create Schema once you have built the schema.
The schema cannot be changed after saving the Destination Connector, so please confirm it is accurate before proceeding.

API Endpoint

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.
​
Copy link
On this page
Overview
Creating an HTTP API Destination Connector
Building the Schema for the API Endpoint
API Endpoint