Skip to content
Postman API Testing Tips

How To Create Index In Elasticsearch Using Postman

API Testing Blog

How to Create an Index in Elasticsearch Using Postman

Elasticsearch is a powerful search engine that leverages JSON documents. To efficiently manage and query these documents, you’ll often need to create indexes. An index acts as a container for your documents, and understanding how to create them is fundamental for successful Elasticsearch development. This guide will walk you through creating Elasticsearch indexes using Postman, showing you how to leverage its API and explore different configurations.

Understanding Elasticsearch Indexes

An index in Elasticsearch is analogous to a database in a relational database system. It provides a logical grouping for your documents. When you create an index, you’re defining a specific structure for storing and querying certain types of data. Each index can have its own unique settings and mappings, allowing you to optimize your search engine for specific use cases.

Prerequisites

  • Elasticsearch Instance: You’ll need a running Elasticsearch instance. If you don’t have one, you can use a free service like Elastic Cloud (formerly Elasticsearch Service) or install Elasticsearch locally.
  • Postman: Download and install Postman, a popular tool for making API requests.

Creating a Simple Index

  1. Open Postman: Launch Postman and create a new request.
  2. Choose HTTP Method: Select POST as the HTTP method.
  3. Set URL: Enter the URL of your Elasticsearch endpoint, followed by the index name you want to create. For example: 
    http://localhost:9200/my_index
    Replace localhost:9200 with the address and port of your Elasticsearch instance and my_index with the desired index name.
  4. Set Headers: Add the following header to your request: 
    Content-Type: application/json
  5. Send the Request: Press Send. You should receive a response with a status code of 200 OK, indicating successful index creation.

Configuring Index Settings

Elasticsearch allows you to fine-tune index settings to optimize performance and behavior. These settings define aspects like:

  • Number of shards: Controls how your index is divided for parallel processing and data distribution.
  • Number of replicas: Determines how many copies of each shard are kept for redundancy and fault tolerance.
  • Refresh interval: Defines how often index changes are made visible for search.

You can configure these settings by including a settings object in the request body:

{
  "settings": {
    "number_of_shards": 5,
    "number_of_replicas": 1,
    "refresh_interval": "1s"
  }
}

Defining Mappings

Mappings specify the structure of your documents within the index. This includes defining data types, setting up analyzers for text fields, and configuring various properties. Here’s an example:

{
  "mappings": {
    "properties": {
      "title": { "type": "text" },
      "author": { "type": "keyword" },
      "published_date": { "type": "date" }
    }
  }
}

This mapping defines three fields:

  • title: A text field that will be analyzed for search.
  • author: A keyword field for storing author names without analysis.
  • published_date: A date field to store dates.

Example: Creating an Index with Settings and Mappings

Let’s combine the above concepts and create an index called books with specific settings and mappings:

{
  "settings": {
    "number_of_shards": 3,
    "number_of_replicas": 0
  },
  "mappings": {
    "properties": {
      "title": { "type": "text" },
      "author": { "type": "keyword" },
      "published_date": { "type": "date" },
      "genre": { "type": "keyword" }
    }
  }
}
  1. In Postman, set the URL to http://localhost:9200/books
  2. Set the Content-Type header to application/json.
  3. Paste the JSON code above into the body of the request.
  4. Click Send.

Testing Your Index

After creating an index, you can test it by sending documents to this index using POST requests. For example, to add a document to the books index:

{
    "title": "The Lord of the Rings",
    "author": "J. R. R. Tolkien",
    "published_date": "1954-07-29",
    "genre": "Fantasy"
}
  1. In Postman, set the URL to: http://localhost:9200/books/_doc
  2. Set the Content-Type header to application/json.
  3. Paste the document JSON above into the body.
  4. Click Send.

Verifying Index Creation

You can check the index you created using the GET method:

http://localhost:9200/books

This will return a JSON response containing the index settings and mappings.

Conclusion

Creating indexes is a cornerstone of working with Elasticsearch. Postman provides a user-friendly interface to interact with the Elasticsearch API, making it easy to create indexes, configure settings, and test their functionality. By following this guide, you can become comfortable with creating indexes in Elasticsearch using Postman, allowing you to build efficient and robust search solutions.

API Testing Blog