LogoLogo
  • Introduction
    • Welcome
    • Quickstart
  • Platform
    • Connections
      • Jobs
      • Sync types
      • Sync schedule
      • Column Anonymization
      • Block Window
    • Connect to databases
    • Running jobs manually
    • Alert Integrations
      • Discord
      • Email
      • Slack
    • Runs history
    • How we move data
  • Connectors
    • APIs
      • ActiveCampaign
      • Amplitude
      • Asaas
      • Asana
      • Bling
      • Beehiiv
      • BomControle
      • Campaign Monitor
      • ClickUp
      • Conta Azul
      • Convenia
      • CustomerX
      • Delighted
      • Facebook Ads
      • FreshChat
      • Freshdesk
      • Gainsight
      • Google Ads
      • Hotmart
      • HubSpot
      • Intercom
      • Jira
      • Linkedin Ads
      • MailChimp
      • MailGun
      • MercadoLibre
      • Mixpanel
      • Monday
      • Movidesk
      • Omie
      • Pipefy
      • Qulture.Rocks
      • RD Station CRM
      • RD Station Marketing
      • Sankhya
      • Sentry
      • Stripe
      • Superlógica
      • Tiny
      • Teamwork Desk
      • Track.co
      • Twitch.tv
      • Twygo
      • Typeform
      • Vindi
      • Zendesk
    • Databases
      • Firebird
      • MySQL
      • Neo4j
      • Oracle
      • PostgreSQL
  • Destinations
    • BigQuery
      • Hosted by Erathos
    • Databricks
    • PostgreSQL
      • Aws (RDS)
      • Azure
    • Redshift
    • S3 Iceberg
  • API
    • Introduction
      • Trigger jobs outside Erathos
      • Trigger jobs in Erathos
    • Quickstart
      • Airflow
      • Dbt Cloud
      • Erathos
      • Prefect
    • Concepts
      • Authentication
      • Metadata
      • Rules
      • Variables and secrets
    • API Reference
      • Jobs
      • Orchestration
      • Secrets
      • Variables
      • Workspaces
  • Settings
    • User settings
    • Workspace settings
Powered by GitBook
On this page
  • Generating an API Key
  • Using the API Key
  1. API
  2. Concepts

Authentication

Create and use an API Key.

PreviousConceptsNextMetadata

Last updated 6 months ago

To make API calls, an API key associated with a user who has the necessary permissions to perform the desired action in the selected workspace is required.

Generating an API Key

To generate a new API key, navigate to Settings and User Settings. In the API Key section select the "Create" Button. The key will only be displayed at the time of creation, so ensure you save it in a secure location, as it cannot be retrieved later.

You can define an expiration date to an api key.

Using the API Key

To authenticate your API requests, include the API key in the header using the following format:

Headers

Name
Value

Authorization

Api-Key <API_KEY>