In this quick tutorial, we will look at how to generate an SDK and create workflows using the Elastic Cloud API.

We recently announced the <a href="/blog/elastic-cloud-elasticsearch-service-api-is-now-ga">general availability of our Elasticsearch Service API</a>. APIs help to automate tasks such as creating and scaling deployments, integrating with existing workflows, and testing.&nbsp;
The Elasticsearch Service API supports the <a href="https://en.wikipedia.org/wiki/OpenAPI_Specification">Open API Specification</a>, which allows you to use tools like <a href="https://swagger.io/">Swagger</a> to generate software development kits (SDKs) in any programming language. You can import the <a href="https://cloud.elastic.co/api/v1/api-docs/spec.json">API spec</a> onto Postman and create a <a href="http://postman.com/collection/">Postman Collection</a> to create a test suite.
In this blog post, we’ll generate an SDK using Swagger and demonstrate how you can perform operations using the Elasticsearch Service API.&nbsp;
<h2>Generating an SDK</h2>Note: If you don’t want to generate an SDK, you can skip this step and use the <a href="https://github.com/aravindputrevu/ess-cloud-sdk-java">ESS Java Client SDK</a>.&nbsp;
As mentioned above, the Elasticsearch Service API follows the Open API Specification. Here, we’ll be using Swagger Generator to generate respective language SDK.&nbsp;
<ol>
	<li>First, <a href="https://cloud.elastic.co/api/v1/api-docs/spec.json">copy the API specification from this link</a>.</li>
	<li>Open <a href="https://editor.swagger.io/">https://editor.swagger.io</a>.</li>
	<li>Paste the API spec in the above link and accept the prompt to convert to YAML.</li>
	<li>Go to Generate Client &gt; Java (we’ll select Java for this tutorial, but you can use the programming language of your choice).</li>
</ol><img src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt5edecb7d7e93365c/5f4f76430ab106265a187e7f/swagger-generator.png" data-sys-asset-uid="blt5edecb7d7e93365c" alt="Using Swagger Generator to generate the SDK" style="display: block; margin: auto;">
We’ve generated a <a href="https://github.com/aravindputrevu/ess-cloud-sdk-java">Java Client SDK</a> and <a href="https://github.com/aravindputrevu/ess-cloud-sdk-java/releases/download/v0.1/cloud-sdk-java.zip">compiled a JAR</a> to use it further as a dependency in our sample application.&nbsp;
<h2>Creating an API key</h2>To perform any of the API calls, we need an API key to talk to Elasticsearch Service securely. This requires an Elastic Cloud account. <a href="http://ela.st/dev-dish">Visit this link to spin up an extended 30-day free trial</a> of Elastic Cloud.
Now you’ll need to create an API key using the Elastic Cloud console. You can do this under the Account section:
<img src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt7f92f076bff5a124/5f4f7690c0ed4228f9e5831f/image4.png" data-sys-asset-uid="blt7f92f076bff5a124" alt="Create a API key from the Elastic Cloud console" style="display: block; margin: auto;">
Note: API keys are sensitive and tied to your account, and they grant privileges to create, list, and destroy resources in Elasticsearch Service. Please keep your keys safe.
<h2>Performing operations using the Elasticsearch Service API and SDK</h2>The Elasticsearch Service API contains multiple operation APIs to manage your deployments.&nbsp;
For example, we can use the SDK to automate essential workflows. I’m using Intellij and a sample Java project to use the SDK jar that we generated earlier. You can also use other editors to do the same thing.
<img src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt220035ca734cfbd9/5f4f77524a7bbc279b84532c/image2.png" data-sys-asset-uid="blt220035ca734cfbd9" alt="Elastic Cloud API as a Postman Collection" style="display: block; margin: auto;">
Here are some operations you can perform with the Elasticsearch Service API SDK:
<ul>
	<li>Create an Elasticsearch Service deployment</li>
</ul><img src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/bltf71d7865c70110d9/5f4f77cab5badb2465bb943c/image5.png" data-sys-asset-uid="bltf71d7865c70110d9" alt="Code for Creating a Elasticsearch Deployment on Elastic Cloud" style="display: block; margin: auto;"> 
<ul>
	<li>List Elasticsearch Service deployments</li>
</ul><img src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/bltced3ff72b160039b/5f4f7826177a662511db2c64/image1.png" data-sys-asset-uid="bltced3ff72b160039b" alt="Code snippet to list Elastic Cloud deployments " style="display: block; margin: auto;">
You can also see the API request equivalent to what you’ve configured in the user interface after selecting the required deployment specifications along with the cloud platform and region.
<img src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/bltabe9e690a7392d5c/5f4f787a891266279cd6e1c4/image3.png" data-sys-asset-uid="bltabe9e690a7392d5c" alt="Equivalent REST API request for the selected Cloud Platform and Region in Elastic Cloud Console" style="display: block; margin: auto;">
To see the list of available regions, refer to the <a href="https://www.elastic.co/guide/en/cloud/current/ec-regions-templates-instances.html">available regions page</a> in our documentation.&nbsp;
<h2>Further reading</h2>Thanks for following along! The code for this project is available in this <a href="https://github.com/aravindputrevu/cloud-sdk-java/">GitHub repository</a>.
If you have any further questions, please do not hesitate to reach out on our community Slack channel #dev-cloud-api (<a href="https://ela.st/slack">request an invite here</a>) or drop a question on our <a href="https://discuss.elastic.co/">forums</a>.

blog-banner-cloud-patterned-blue.png

blog-thumb-cloud-patterned-blue.png

Automate Elastic Cloud workflows using an SDK and Elasticsearch Service API

A start-to-finish Elastic App Search tutorial for creating a search experience with a Python client and containerizing the app to deploy on a cloud platform.

This post is a brief summary of a <a href="https://www.youtube.com/watch?v=gVtQ42Fp_v8">presentation</a> I gave recently where I deploy Elastic App Search, show off the ease of setup, data indexing, and relevance tuning, and take look at a few of the many refined APIs. It’s also <a href="https://guides.aravind.dev/codelabs/elastic-app-search-python/#0">written up in a codelab</a> with step-by-step instructions for building a movies search engine app using Python Flask. The app will work on desktop or mobile and is a fast, simple, and reliable way to query the information. Here’s a quick summary of what you’ll learn:
<ul>
	<li>Creating an App Search instance on Elastic Cloud</li>
	<li>Navigating to the admin console</li>
	<li>Ingesting data</li>
	<li>Creating a search experience with a Python client</li>
	<li>Containerizing the app and deploying it on a cloud platform</li>
</ul> <h2>A little insight on App Search</h2>Elastic App Search is a ready-to-use, complete search solution with user-friendly relevance tuning and analytics built in. It lets users — of almost any skill level — easily add a powerful and customizable search experience to any application, website, or mobile app using a refined set of APIs and management tools. You can deploy App Search instances from the Elastic Cloud dashboard, so you get all the tooling needed for a powerfully relevant search experience with the operational flexibility and scale of Elastic Cloud. It powers search for thousands of popular applications around the world and it's backed by the speed and relevance of <a href="https://github.com/elastic/elasticsearch">Elasticsearch</a>, no matter how large your deployment grows.
<img clas="shadow" src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/bltb189d60f5a105ae7/5db0fb016af83b6d7032cd04/illustrated-screenshot-hero-app-search.png" data-sys-asset-uid="bltb189d60f5a105ae7" alt="Elastic App Search UI visualization" style="display: block; margin: auto;"> 
<h2>Starting the App Search tutorial</h2>The tutorial uses Elastic Cloud to deploy App Search. If you’re not a current Elastic Cloud user, you can <a href="https://cloud.elastic.co/registration">spin up a free 14-day trial</a>. Then you can jump to the codelab and/or the video presentation to follow along:
<ul>
	<li><a href="https://guides.aravind.dev/codelabs/elastic-app-search-python/#0">Codelab tutorial</a></li>
	<li><a href="https://www.youtube.com/watch?v=gVtQ42Fp_v8">YouTube video of this guide</a></li>
</ul><a href="https://guides.aravind.dev/codelabs/elastic-app-search-python/#0"><img class="shadow" src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt02ddbbd5599aa4a4/5f20592ec82cd309f62e4ad6/app-search-python-tutorial-blog.png" style="background-color: initial; display: block; margin: auto;" data-sys-asset-uid="blt02ddbbd5599aa4a4" alt="App Search codelab tutorial"></a>
Thanks for following along! Looking for something to read next? Check out <a href="https://www.elastic.co/blog/how-to-build-great-react-search-experiences-quickly">How to build React search experiences quickly</a> and <a href="https://www.elastic.co/blog/what-your-elastic-app-search-analytics-are-telling-you">What your Elastic App Search analytics are telling you</a>.

app-search-blog-banner.png

app-search-blog-thumb.png

Building a Python web application with Elastic App Search

Our new workspace on Slack's got your back if you get off track with the Elastic Stack.

A few weeks back, <a href="https://twitter.com/elastic/status/1202400283931734016">we announced our community Slack workspace</a>. While we already have great platforms (like <a href="http://discuss.elastic.co/">Discuss</a>&nbsp;and <a href="https://www.elastic.co/elasticon/">Elastic{ON} Tour</a>)&nbsp;and <a href="http://community.elastic.co/">community programs</a> for engaging with our users, this new <a href="https://elasticstack.slack.com/">Slack workspace</a> makes for a lively way for our community to interact with each other, as well as a great new way for users to stay updated with the latest happenings in Elastic Stack.
So whether you're looking for help on a Beats module you've been developing, trying to find testers for a new Kibana plugin pet project, or even just trying to find the latest meetup happening in your city, the Slack workspace can be a great place for questions, answers, and community collaboration.
Our Slack channels have users joining from all over the world to interact on various products and solutions like #elasticsearch, #app-search, and #logs. And we also have the #usergroup-organizers channel where you can engage with our global community organizers.
So if you’re looking to be more active in the Elastic community — and you’ve got room in your channel list — please join the Slack group using this link: <a href="https://ela.st/slack">https://ela.st/slack</a>.
For any questions or suggestions please reach out to our #slack-moderators channel.
 <img src="https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blta137a2f6e3b0cde7/5e2b6feee147ae4537d91fa6/elastic-slack-blog-welcome-body.jpg" data-sys-asset-uid="blta137a2f6e3b0cde7" alt="" style="display: block; margin: auto; width: 600px">

Articles by Aravind Putrevu

Automate Elastic Cloud workflows using an SDK and Elasticsearch Service API

Building a Python web application with Elastic App Search

Join our Elastic Stack workspace on Slack

Products & Solutions

Company

Resources