Skip to content
English
Customer portal
Go to zetaris.com
  • There are no suggestions because the search field is empty.

Accessing Zetaris using API

This article explains how to configure Postman for Zetaris API access, authenticate using Org ID, credentials& API Key, store and reuse tokens securely and begin testing Zetaris APIs using the official OpenAPI documentation

1. Prerequisites

You will need the following:

Item Who Provides
Zetaris Org ID Zetaris Support / Admin
Username & Password Zetaris
API Key Zetaris Console
Postman (v11+) User
Zetaris API Docs (Redoc) Zetaris

2. Create a Postman Workspace

  1. Open Postman

  2. Click Workspaces → Create Workspace

  3. Workspace name

3. Import Zetaris Environment Variables

  • Steps

    • Open Environments

    • Click Import

    • Import the provided file: 

      Zetaris API Environment Variables.json

  • Variables Included

Variable Description
baseUrl Zetaris SaaS API endpoint
orgId Customer organization ID
username Login username
password Login password
requestId UUID for request tracing

  • Update the following values:

    • orgId

    • username

    • password

4. Authenticate Using Login API

  • Create Login Request
Setting Value
Method GET
URL /api/v1.0/auth/login
  • Headers
Header Value
X-Request-ID
X-Org-ID
  • Authorization

    • Type: Basic Auth

    • Username:

    • Password:

  • Successful Response
{
  "idToken": "ey...",
  "refreshToken": "ey..."
}

5. Save Tokens in Environment

Add the following environment variables:

idToken = <returned idToken>
refreshToken = <returned refreshToken>

6. Configure API Key (Bearer Authentication)

For all APIs beyond login:

    • Open Authorization tab

    • Select Bearer Token

    • Paste your Zetaris API Key

    • ⚠️ Both Bearer API Key and required headers must be present

7. Start Using Zetaris APIs

From this point onward, use the official Zetaris API documentation:

https://api.saas.enterprise.zetaris.com/redoc/index.html

Recommended starting points:

    • DataCatalog APIs

    • DataMart APIs

    • Lightning Database APIs

    • Pipeline APIs

    • SQL Query APIs

8. API Categories

Category Purpose
Auth Login & token refresh
DataCatalog Metadata tagging & discovery
DataMart Data mart & table listing
LightningDatabase File-store metadata
Pipeline Create, clone, patch, execute pipelines
SQL Query Start, page, and close SQL queries