Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Deployments API

Manage Elasticsearch and Kibana deployments.

Elastic Deployments API is one of 12 APIs that Elastic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deployments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.elastic-cloud.com.

4 operations 2 paths 1 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.elastic-cloud.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Elastic Deployments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — ApiKey

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Deployments 4

Manage Elasticsearch and Kibana deployments.

GET
/api/v1/deployments
List deployments
listDeployments → 200
POST
/api/v1/deployments
Create a deployment
createDeployment body → 201
GET
/api/v1/deployments/{deployment_id}
Get a deployment
getDeployment 1 param → 200404
DELETE
/api/v1/deployments/{deployment_id}
Delete a deployment
deleteDeployment 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Deployment (4 properties). Each schema is shown below with its type and property counts.

Deployment
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-deployments-api-openapi.yml Raw ↑

Other APIs Elastic publishes across the network.

Elastic Account API
Elastic Cluster API
Elastic DataViews API
Elastic Documents API
Elastic Indices API
Elastic SavedObjects API
Elastic Search API
Elastic Security API
Elastic Spaces API
Elastic Status API
Elastic TrafficFilters API