Skip to main content

​
Connection Configuration

FieldTypeRequiredDescription
endpointstring✅Server endpoint URL (https://my-cluster.es.amazonaws.com)
auth_methodenum✅Authentication: basic, api_key, or none
usernamestring—Required for Basic auth
passwordstring—Required for Basic auth
api_key_idstring—Required for API Key auth
api_key_secretstring—Required for API Key auth

​
Example Configuration (Basic Auth)

{
  "endpoint": "https://my-cluster.es.amazonaws.com",
  "auth_method": "basic",
  "username": "elastic",
  "password": "••••••••"
}

​
Example Configuration (API Key)

{
  "endpoint": "https://my-cluster.es.amazonaws.com",
  "auth_method": "api_key",
  "api_key_id": "your_api_key_id",
  "api_key_secret": "••••••••"
}

​
Setup Requirements

  1. Ensure your Elasticsearch cluster is accessible over HTTPS
  2. Create an index or let Jobo create it automatically on first sync
  3. Configure appropriate authentication credentials (Basic auth or API Key)
Jobs are upserted by their unique ID, so re-syncs won’t create duplicates.