Elastic Cloud API logo
Elastic APIs hub
  • Elastic Cloud API
  • Elastic Cloud Billing API
  • Elastic Cloud Enterprise API
  • Elastic Cloud Serverless API
  • Elasticsearch API
  • Elasticsearch Serverless API
  • Kibana API
  • Kibana Serverless API
  • Logstash API
  • Observability Intake Serverless API
Back to hub page
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification

Topics

  • Introduction
  • Principles
  • Rate limiting
  • Authentication

Endpoints

  • Accounts
    • Fetch current account information GET
    • Updates the current account PUT
    • Updates the current account PATCH
  • Authentication
    • Get all API keys GET
    • Create API key POST
    • Delete API keys DELETE
    • Get API key GET
    • Delete API key DELETE
  • Billing costs analysis
    • Get costs overview for the organization. Currently unavailable in self-hosted ECE. GET
    • Get charts for the organization. Currently unavailable in self-hosted ECE. GET
    • Get deployments costs for the organization. Currently unavailable in self-hosted ECE. GET
    • Get charts by deployment. Currently unavailable in self-hosted ECE. GET
    • Get itemized costs by deployments. Currently unavailable in self-hosted ECE. GET
    • Get itemized costs for the organization. Currently unavailable in self-hosted ECE. GET
  • Deployments
    • List Deployments GET
    • Create Deployment POST
    • Search Deployments POST
    • Get eligible remote clusters POST
    • Get Deployment GET
    • Update Deployment PUT
    • Restores a shutdown Deployment POST
    • Shuts down Deployment POST
    • Get Deployment APM Resource Info GET
    • Reset the secret token for an APM resource. POST
    • Get Deployment App Search Resource Info GET
    • Set AppSearch read-only status GET
    • Set AppSearch read-only status PUT
    • Get certificate authority GET
    • Get Deployment Elasticsearch Resource Info GET
    • Migrate Elasticsearch and associated Kibana resources to enable CCR POST
    • Migrate Elasticsearch resource to use ILM POST
    • Migrate Elasticsearch resource to use SLM POST
    • Reset 'elastic' user password POST
    • Restart Deployment Elasticsearch Resource POST
    • Shutdown Deployment Elasticsearch Resource POST
    • Get eligible remote clusters POST
    • Get the items in the Elasticsearch resource keystore GET
    • Add or remove items from the Elasticsearch resource keystore PATCH
    • Get certificate based remote clusters GET
    • Set certificate based remote clusters PUT
    • Get Deployment Enterprise Search Resource Info GET
    • Get Deployment Integrations Server Resource Info GET
    • Get Deployment Kibana Resource Info GET
    • Build request to migrate deployment to a different template GET
    • Get Deployment upgrade assistant status GET
    • Restores a shutdown resource POST
    • Start all instances POST
    • Stop all instances POST
    • Start maintenance mode (all instances) POST
    • Stop maintenance mode (all instances) POST
    • Start instances POST
    • Stop instances POST
    • Start maintenance mode POST
    • Stop maintenance mode POST
    • Cancel resource pending plan DELETE
    • Restart Deployment Stateless Resource POST
    • Shutdown Deployment Stateless Resource POST
  • Deployments - Extensions
    • List Extensions GET
    • Create an extension POST
    • Get Extension GET
    • Uploads the Extension PUT
    • Update Extension POST
    • Delete Extension DELETE
  • Deployments - Templates
    • Get deployment templates GET
    • Get deployment template GET
  • Deployments - Traffic filter
    • Get associated rulesets GET
    • List traffic filter claimed link id GET
    • Claim a link id POST
    • Unclaims a link id POST
    • List traffic filter rulesets GET
    • Create a ruleset POST
    • Retrieves the ruleset by ID. GET
    • Updates a ruleset PUT
    • Delete a ruleset DELETE
    • Get associated deployments GET
    • Create ruleset association POST
    • Delete ruleset association DELETE
  • Organizations
    • List organizations GET
    • Get organization invitation GET
    • Accept an organization invitation POST
    • Fetch organization information GET
    • Update organization PUT
    • Get domain claims GET
    • Delete domain claim DELETE
    • Generate verification code POST
    • Verify domain claim POST
    • Get organization IdP GET
    • Setup organization IdP PUT
    • Tear down organization IdP DELETE
    • Get organization service provider SAML2 metadata.xml for configuring the identity provider GET
    • List organization invitations GET
    • Create organization invitations POST
    • Delete organization invitations DELETE
    • List organization members GET
    • Delete organization memberships DELETE
    • Get role mappings GET
    • Updates role mappings PUT
    • Delete role mappings DELETE
  • Stack - Versions - CRUD
    • Get stack versions GET
  • Trusted environments
    • Get trusted environments GET
  • Users - Role Assignments
    • Add Role Assignments POST
    • Remove Role Assignments DELETE
Powered by Bump.sh