Elastic Cloud (ESS) API Summary Table

elastic_cloud_apis.md

doc, generate api key

object	doc	description	url
APM routes	doc	Reset secret tokens for your APM resources.	POST /api/v1/deployments/{deployment_id}/apm/{ref_id}/_reset-token
Accounts	doc	Retrieve and update the current Elasticsearch Service account.	GET /api/v1/account PATCH /api/v1/account PUT /api/v1/account
App Search (Read only)	doc	Enable read only mode on an App Search resource.	GET /api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode PUT /api/v1/deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode
Authentication	doc	Manage your Elasticsearch Service API keys.	DELETE /api/v1/users/auth/keys GET /api/v1/users/auth/keys POST /api/v1/users/auth/keys DELETE /api/v1/users/auth/keys/{api_key_id} GET /api/v1/users/auth/keys/{api_key_id}
Billing Costs Analysis	doc	Get an overview of your costs by organization ID.	GET /api/v1/billing/costs/{organization_id} GET /api/v1/billing/costs/{organization_id}/deployments GET /api/v1/billing/costs/{organization_id}/deployments/{deployment_id}/items GET /api/v1/billing/costs/{organization_id}/items
Deployment CRUD	doc	Perform CRUD operations on your deployments.	GET /api/v1/deployments POST /api/v1/deployments GET /api/v1/deployments/{deployment_id} PUT /api/v1/deployments/{deployment_id} POST /api/v1/deployments/{deployment_id}/_restore POST /api/v1/deployments/{deployment_id}/_shutdown
Deployment Commands	doc	Manage resources in your deployments.	POST /api/v1/deployments/_search POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop POST /api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart POST /api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown POST /api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_upgrade
Deployment Info	doc	Retrieve information about resources in your deployments.	GET /api/v1/deployments/{deployment_id}/apm/{ref_id} GET /api/v1/deployments/{deployment_id}/appsearch/{ref_id} GET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id} GET /api/v1/deployments/{deployment_id}/enterprise_search/{ref_id} GET /api/v1/deployments/{deployment_id}/integrations_server/{ref_id} GET /api/v1/deployments/{deployment_id}/kibana/{ref_id}
Deployment Remote Clusters	doc	Retrieve and set remote clusters.	UNK
Deployment Resources CRUD	doc	Manage an Elasticsearch keystore, restore a shutdown resource, and cancel a pending plan.	GET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore PATCH /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore DELETE /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending
Deployments Extensions	doc	Manage the extensions for your deployment.	GET /api/v1/deployments/extensions POST /api/v1/deployments/extensions DELETE /api/v1/deployments/extensions/{extension_id} GET /api/v1/deployments/extensions/{extension_id} POST /api/v1/deployments/extensions/{extension_id} PUT /api/v1/deployments/extensions/{extension_id}
Deployments Templates	doc	Retrieve available deployment templates.	GET /api/v1/deployments/templates GET /api/v1/deployments/templates/{template_id}
Deployments Traffic Filter Associations %% traffic filtering %%	doc	Retrieve and set associations between your deployments and traffic filter rulesets.	GET /api/v1/deployments/traffic-filter/associations/{association_type}/{associated_entity_id}/rulesets GET /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}/associations POST /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}/associations DELETE /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}/associations/{association_type}/{associated_entity_id}
Deployments Traffic Filter CRUD %% traffic filtering %%	doc	Perform CRUD operations on your traffic filter rulesets.	GET /api/v1/deployments/traffic-filter/rulesets POST /api/v1/deployments/traffic-filter/rulesets DELETE /api/v1/deployments/traffic-filter/rulesets/{ruleset_id} GET /api/v1/deployments/traffic-filter/rulesets/{ruleset_id} PUT /api/v1/deployments/traffic-filter/rulesets/{ruleset_id}
Stack Versions CRUD	doc	Retrieve the available Elastic Stack versions for your deployments.	GET /api/v1/stack/versions
Organizations	doc	Manage organization invitations and memberships.	GET /api/v1/organizations GET /api/v1/organizations/invitations/{invitation_token} POST /api/v1/organizations/invitations/{invitation_token}/_accept GET /api/v1/organizations/{organization_id} PUT /api/v1/organizations/{organization_id} GET /api/v1/organizations/{organization_id}/invitations POST /api/v1/organizations/{organization_id}/invitations DELETE /api/v1/organizations/{organization_id}/invitations/{invitation_tokens} GET /api/v1/organizations/{organization_id}/members DELETE /api/v1/organizations/{organization_id}/members/{user_ids}