Skip to main content
Elasticsearch logo

Elasticsearch

Overview​

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:

  1. Log in to your Elasticsearch account
  2. Navigate to Manage this deployment via the sidebar
  3. Click on Copy endpoint for your Elasticsearch application
  4. Paste the endpoint as the Elasticsearch host in Superblocks
  5. Navigate back to the homepage for your Elasticsearch deployment, then search for "users" and navigate to Security/Users
  6. [Optional] Click Create user
    • Fill in the required fields and assign appropriate privileges
  7. 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

Add integration

Once you have an access token, you're ready to set up your Superblocks integration.

  1. In the web app, navigate to the Integrations page
  2. Click on the Elasticsearch tile
  3. Name the integration
  4. Paste your credentials into the relevant fields
  5. Optionally, add more configurations to set credentials for different environments
  6. Click Create
tip

Elasticsearch connected!
Now you can use Elasticsearch in any Application, Workflow, or Scheduled Job.

Use Elasticsearch in APIs​

Once your Elasticsearch integration is created, you can start calling Elasticsearch actions in Superblocks APIs.

Elasticsearch actions are REST requests. To learn more about REST requests in Superblocks, see the Building REST requests guide.

Supported actions​

Get aliases

Returns an alias.

Get aliases with name

Returns an alias.

Get aliases with index

Returns an alias.

Get aliases with index and name

Returns an alias.

Create or update alias

Creates or updates an alias.

Delete alias

Deletes an alias.

Update aliases

Updates index aliases.

Create or update aliases

Create or update aliases.

Delete aliases

Deletes aliases.

Get number of documents

Returns number of documents matching a query.

Get number of documents with index

Returns number of documents matching a query.

Get info about indices

Returns information about one or more indices.

Create an index

Creates an index with optional settings and mappings.

Delete an index

Deletes an index.

Get stats with index

Provides statistics on operations happening with index.

Get stats with index metric

Provides statistics on operations happening with index.

Create a document with index

Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index.

Explain a query

Returns information about why a specific matches (or doesn't match) a query.

Resolve an index

Returns information about any matching indices, aliases, and data streams.

Refresh an index

Performs the refresh operation in one or more indices.

Get a pipeline

Returns a pipeline.

Simulate a pipline

Allows to simulate a pipeline with example documents.

Get a pipeline with id

Returns a pipeline.

Create or update a pipeline

Creates or updates a pipeline.

Delete a pipeline

Deletes a pipeline.

Simulate a pipeline with id

Allows to simulate a pipeline with example documents.

Get patterns

Returns a list of the built-in patterns.

Get mappings

Returns mappings for one or more indices.

Get mappings for fields

Returns mapping for one or more fields.

Get mappings for fields and indices

Returns mapping for one or more fields.

Get mappings for indices

Returns mappings for one or more indices.

Update mappings

Updates the index mappings.

Get multiple documents

Allows to get multiple documents in one request.

Get multiple documents with index

Allows to get multiple documents in one request.

Search mutiple templates

Allows to execute several search template operations in one request.

Search multiple operations with index

Allows to execute several search operations in one request.

Search multiple operations

Allows to execute several search operations in one request.

Get multiple termvectors with index

Returns multiple termvectors in one request.

Get multiple termvectors

Returns multiple termvectors in one request.

List all points in time

Lists all active point in time searches.

Delete all points in time

Deletes all active point in time searches.

Delete a point in time

Deletes one or more point in time searches based on the IDs passed.

Search

Returns results matching a query.

Create a point in time

Creates point in time context.

Search within an index

Returns results matching a query.

Search shards with index

Returns information about the indices and shards that a search request would be executed against.

Search shards

Returns information about the indices and shards that a search request would be executed against.

Get termvectors with id

Returns information and statistics about terms in the fields of a particular document.

Get termvectors

Returns information and statistics about terms in the fields of a particular document.
and 34 more

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.

info

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.