Elasticsearch offers powerful search and analytics capabilities. Connect with Elasticsearch to create customized search solutions, automate data retrieval tasks, synchronize information across applications, and enhance your data analytics in Superblocks.
Setting up Elasticsearch
Create an access token
To begin using Elasticsearch, follow these steps:
- Log in to your Elasticsearch account
- Navigate to Manage this deployment via the sidebar
- Click on Copy endpoint for your Elasticsearch application
- Paste the endpoint as the Elasticsearch host in Superblocks
- Navigate back to the homepage for your Elasticsearch deployment, then search for "users" and navigate to Security/Users
- [Optional] Click Create user
- Fill in the required fields and assign appropriate privileges
- Grab the username and password for the user you will use to authenticate and add them to the integration's configuration form in Superblocks
Learn more about Elasticsearch API Authentication.
Once you have an access token, you're ready to set up your Superblocks integration.
- In the web app, navigate to the Integrations page
- Click on the Elasticsearch tile
- Name the integration
- Paste your credentials into the relevant fields
- Optionally, add more configurations to set credentials for different environments
- Click Create
Use Elasticsearch in APIs
Once your Elasticsearch integration is created, you can start creating steps in Application backend APIs, Workflows, and Scheduled Jobs to call Elasticsearch API actions. Elasticsearch actions are REST requests. To learn more about REST requests in Superblocks, see the Building REST requests guide.
Get aliasesReturns an alias.
Get aliases with nameReturns an alias.
Get aliases with indexReturns an alias.
Get aliases with index and nameReturns an alias.
Create or update aliasCreates or updates an alias.
Delete aliasDeletes an alias.
Update aliasesUpdates index aliases.
Create or update aliasesCreate or update aliases.
Delete aliasesDeletes aliases.
Get number of documentsReturns number of documents matching a query.
Get number of documents with indexReturns number of documents matching a query.
Get info about indicesReturns information about one or more indices.
Create an indexCreates an index with optional settings and mappings.
Delete an indexDeletes an index.
Get stats with indexProvides statistics on operations happening with index.
Generic HTTP Request
Every SaaS integration in Superblocks comes with a built in Generic HTTP Request Action. This is a powerful action you can use to call Elasticsearch API endpoints not in the Superblocks supported actions.
To use this action simply add the method, path, required query parameters, and body for the desired endpoint.
Learn more about REST requests in Superblocks in our Building REST requests guide.
Generic HTTP Requests use the authentication set up and base URL you've configured for your integration, making it an easy for your team to extend Superblocks Integrations to meet their needs.