API overview

The Imply Polaris API provides programmatic access to working with tables, files, and ingestion tasks in Polaris.

Polaris supports API key and OAuth authentication methods. For more information on authenticating REST API requests, see Authentication overview.

The following diagram presents a high-level approach to working with the Polaris API. Navigate to the associated developer guide in the list below to learn more about any step.

API workflow diagram

  1. Create a table: Create a table using the Tables API.

  2. Define a schema: Validate and set a table's schema.

  3. Perform a batch ingestion:
    a. Upload files to a staging area.
    b. Start batch ingestion job from files.

  4. Push event data into a table:
    a. Create a connection to push data from a source data stream.
    b. Start the streaming ingestion job.
    c. Push events to the table.

  5. Ingest data from an event provider:
    a. Create a connection to an event provider.
    b. Start the streaming ingestion job.

  6. Query data: Submit SQL queries using the Query API.

See the following topics for integrating external applications with Polaris:

For more information on the APIs, see API reference.

← Connect to AWSOverview →