- Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure: other versions:
- Introducing Elastic Cloud Enterprise
- Preparing your installation
- Installing Elastic Cloud Enterprise
- Identify the deployment scenario
- Install ECE with Ansible
- Install ECE on a public cloud
- Install ECE on your own premises
- Log into the Cloud UI
- Install ECE on additional hosts
- Post-installation steps
- Configuring your installation
- Securing your installation
- Monitoring your installation
- Administering your installation
- Getting started with deployments
- Administering deployments
- Change your deployment configuration
- Stop routing requests or pause nodes
- Terminate a deployment
- Restart a deployment
- Restore a deployment
- Delete a deployment
- Migrate to index lifecycle management
- Access the Elasticsearch API console
- Work with snapshots
- Upgrade versions
- Upgrade App Search to Enterprise Search
- Editing your user settings
- Configure Beats and Logstash with Cloud ID
- Keep your clusters healthy
- Secure your clusters
- Reset the password for the
elasticuser - Manage users and roles in X-Pack
- Manage users and roles in Shield
- Configure the Java Transport client
- Secure your settings
- Secure your 7.x clusters with LDAP
- Secure your 7.x clusters with Active Directory
- Secure your 5.x and 6.x clusters with LDAP
- Secure your 5.x and 6.x clusters with Active Directory
- Secure your clusters with SAML
- Secure your clusters with OpenID Connect
- Secure your clusters with Kerberos
- Reset the password for the
- Traffic Filtering
- Manage your Kibana instance
- Manage your APM Server
- Enable Graph (versions before 5.0)
- Enable logging and monitoring
- Connect to your cluster
- Enable cross-cluster search
- Enable App Search
- Enable Enterprise Search
- Troubleshooting
- RESTful API
- Authentication
- API calls
- Access the API from the Command Line
- Create an API client
- API examples
- Setting up your environment
- A first API call: What deployments are there?
- Create a first deployment: Just an Elasticsearch cluster
- Create a Deployment: Elasticsearch Cluster and Kibana instance
- Updating a deployment: Resize and add high availability
- Updating a deployment: Checking on progress
- Applying a new deployment configuration: Upgrade
- Enable more stack features: Add Kibana to a deployment
- Dipping a toe into platform automation: Generate a roles token
- Customize your deployment
- Remove unwanted deployment templates and instance configurations
- Secure your settings
- API reference
- API - Base Url
- APM routes
- App Search - Read-only
- Authentication
- User authentication information
- Disable elevated permissions
- Enable elevated permissions
- Login to ECE
- Logout from ECE
- Refresh authentication token
- Delete API keys
- Get all API keys
- Create API key
- Delete API keys of multiple users
- Get all API keys for all users
- Delete API key
- Get API key
- Available authentication methods
- Re-authenticate to generate a token
- SAML callback
- Initiate SAML protocol
- Delete API keys for a user
- Get all API keys for a user
- Delete an API key for a user
- Get a user API key
- Clusters - Apm - CRUD
- Clusters - Apm - CRUD - Configuration
- Clusters - Apm - Commands
- Resynchronize clusters
- Search clusters
- Restart cluster
- Resynchronize cluster
- Shut down cluster
- Upgrade cluster
- Move instances (advanced)
- Start all instances
- Stop all instances
- Start maintenance mode all instances
- Stop maintenance mode all instances
- Move instances
- Start instances
- Stop instances
- Start maintenance mode
- Stop maintenance mode
- Clusters - Elasticsearch - CRUD
- Clusters - Elasticsearch - CRUD - Configuration
- Get cross-cluster search clusters
- Get remote clusters for cross-cluster search
- Set remote clusters for cross-cluster search
- Get cluster curation settings
- Update cluster curation settings
- Set settings overrides (all instances)
- Set settings overrides
- Get settings from this cluster’s keystore
- Add or remove settings from the cluster keystore
- Set cluster name
- Get cluster metadata
- Set cluster metadata
- Get cluster metadata settings
- Update cluster metadata settings
- Cancel monitoring
- Set monitoring
- Get plan
- Update plan
- Migrate plan
- Get plan activity
- Cancel pending plan
- Get pending plan
- Set legacy security settings
- Get cluster snapshot settings
- Update cluster snapshot settings
- Clusters - Elasticsearch - Commands
- Resynchronize clusters
- Search clusters
- Restart cluster
- Resynchronize cluster
- Shut down cluster
- Take snapshot
- Move instances (advanced)
- Start all instances
- Stop all instances
- Start maintenance mode all instances
- Stop maintenance mode all instances
- Move instances
- Start instances
- Stop instances
- Start maintenance mode
- Stop maintenance mode
- Clusters - Elasticsearch - Proxy
- Clusters - Elasticsearch - Support
- Clusters - Kibana - CRUD
- Clusters - Kibana - CRUD - Configuration
- Clusters - Kibana - Commands
- Resynchronize clusters
- Search clusters
- Restart cluster
- Resynchronize cluster
- Shut down cluster
- Upgrade cluster
- Move instances (advanced)
- Start all instances
- Stop all instances
- Start maintenance mode all instances
- Stop maintenance mode all instances
- Move instances
- Start instances
- Stop instances
- Start maintenance mode
- Stop maintenance mode
- Clusters - Kibana - Proxy
- Clusters - Search
- Comments
- Deployment - CRUD
- Deployment - Commands
- Search Deployments
- Migrate Elasticsearch resource to use ILM
- Migrate Elasticsearch resource to use SLM
- Reset elastic user password
- Restart Deployment Elasticsearch Resource
- Shutdown Deployment Elasticsearch Resource
- Start all instances
- Stop all instances
- Start maintenance mode (all instances)
- Stop maintenance mode (all instances)
- Start instances
- Stop instances
- Start maintenance mode
- Stop maintenance mode
- Restart Deployment Stateless Resource
- Shutdown Deployment Stateless Resource
- Upgrade Kibana, APM, AppSearch inside Deployment
- Deployment - Info
- Deployment - Remote Clusters
- Deployment - resync
- Deployment Resources - CRUD
- Deployments - Extensions
- Deployments - IP Filtering - CRUD
- Deployments - Notes
- Deployments - Templates
- Deployments - Traffic Filter - Associations
- Deployments - Traffic Filter - CRUD
- Networking - Deployment Domain Names
- Platform
- Platform - Adminconsoles
- Platform - Allocators
- Get allocators
- Resynchronize allocators
- Search allocators
- Delete allocator
- Get allocator
- Resynchronize allocator
- Move clusters
- Move clusters by type
- Delete allocator logging settings
- Get allocator logging settings
- Update allocator logging settings
- Set allocator logging settings
- Start maintenance mode
- Stop maintenance mode
- Get allocator metadata
- Set allocator metadata
- Delete allocator metadata item
- Set allocator metadata item
- Get allocator settings
- Update allocator settings
- Set allocator settings
- Platform - Configuration - Instances - CRUD
- Platform - Configuration - Security
- Platform - Configuration - Security - Extra Certificates - CRUD
- Platform - Configuration - Security Deployment
- Platform - Configuration - Security Realms
- List security realm configurations
- Reorder security realms
- Create Active Directory configuration
- Delete Active Directory configuration
- Get Active Directory configuration
- Update Active Directory configuration
- Create LDAP configuration
- Delete LDAP configuration
- Get LDAP configuration
- Update LDAP configuration
- Create SAML configuration
- Delete SAML configuration
- Get SAML configuration
- Update SAML configuration
- Platform - Configuration - TLS
- Platform - Constructors
- Platform - License
- Platform - Repository - CRUD
- Platform - Runners
- Platform - configuration - Store
- Platform - proxies
- Roles
- Stack - Instance Types - CRUD
- Stack - Versions - CRUD
- Telemetry
- Templates - Deployments - Global
- Templates - Deployments - Legacy
- Users
- Definitions
AbsoluteRefIdAccountTrustRelationshipActiveDirectoryGroupSearchActiveDirectorySecurityRealmLoadBalanceActiveDirectorySecurityRealmRoleMappingRuleActiveDirectorySecurityRealmRoleMappingRulesActiveDirectorySettingsActiveDirectoryUserSearchAdminconsoleInfoAdminconsolesOverviewAllocatedInstancePlansInfoAllocatedInstanceStatusAllocatorBuildInfoAllocatorCapacityAllocatorCapacityMemoryAllocatorHealthStatusAllocatorInfoAllocatorMoveRequestAllocatorOverviewAllocatorSettingsAllocatorZoneInfoAllocatorsSummaryAllocatorsZoneSummaryApiBaseUrlDataApiKeyResponseApiKeysResponseApmApmConfigurationApmCrudResponseApmInfoApmPayloadApmPlanApmPlanControlConfigurationApmPlanInfoApmPlansInfoApmResourceInfoApmSettingsApmSubInfoApmSystemSettingsApmTopologyElementApmsInfoAppSearchAppSearchConfigurationAppSearchInfoAppSearchNodeTypesAppSearchPayloadAppSearchPlanAppSearchPlanControlConfigurationAppSearchPlanInfoAppSearchPlansInfoAppSearchResourceInfoAppSearchSettingsAppSearchSubInfoAppSearchSystemSettingsAppSearchTopologyElementAuthenticationInfoAutodetectStrategyConfigAvailableAuthenticationMethodsBasicFailedReplyBasicFailedReplyElementBlessingBlessingsBlessingsWithMetaBoolQueryCapacityConstraintsResourceChangeSourceInfoClusterCommandResponseClusterCredentialsClusterCrudResponseClusterCurationSettingsClusterCurationSpecClusterInfoClusterInstanceConfigurationInfoClusterInstanceDiskInfoClusterInstanceInfoClusterInstanceMemoryInfoClusterLicenseInfoClusterMetadataCpuResourcesSettingsClusterMetadataInfoClusterMetadataPortInfoClusterMetadataResourcesSettingsClusterMetadataSettingsClusterPlanMigrationResponseClusterPlanStepInfoClusterPlanStepLogMessageInfoClusterSnapshotRepositoryDefaultClusterSnapshotRepositoryInfoClusterSnapshotRepositoryReferenceClusterSnapshotRepositoryStaticClusterSnapshotRequestClusterSnapshotResponseClusterSnapshotRetentionClusterSnapshotSettingsClusterSystemAlertClusterTopologyInfoClusterUpgradeInfoClustersInfoCommentCommentCreateRequestCommentUpdateRequestCommentWithMetaCommentsWithMetasCompatibleNodeTypesResourceCompatibleVersionResourceConfigStoreOptionConfigStoreOptionDataConfigStoreOptionListConstructorHealthStatusConstructorInfoConstructorOverviewContainerConfigHostConfigContainerSetSummaryContainerSetsSummaryContainersEntryContainersEntryOptionsContainersEntryOptionsACLContainersEntryOptionsAuthContainersEntryOptionsContainerConfigContainersEntryOptionsOverridesCoordinatorSummaryCoordinatorsSummaryCreateApiKeyRequestCreateApmInCreateElasticsearchRequestCreateApmRequestCreateAppSearchRequestCreateElasticsearchClusterRequestCreateEnterpriseSearchRequestCreateExtensionRequestCreateKibanaInCreateElasticsearchRequestCreateKibanaRequestCreatesCrossClusterSearchClustersCrossClusterSearchInfoCrossClusterSearchSettingsDeleteApiKeysRequestDeleteUsersApiKeysRequestDeploymentCreateMetadataDeploymentCreateRequestDeploymentCreateResourcesDeploymentCreateResponseDeploymentCreateSettingsDeploymentDeleteResponseDeploymentDiagnosticsDeploymentDomainNameDeploymentGetResponseDeploymentLoggingDeploymentLoggingSettingsDeploymentMetadataDeploymentMetricsDeploymentMetricsSettingsDeploymentObservabilityDeploymentObservabilitySettingsDeploymentResourceDeploymentResourceCommandResponseDeploymentResourceCrudResponseDeploymentResourceUpgradeResponseDeploymentResourcesDeploymentRestoreResponseDeploymentSearchResponseDeploymentSettingsDeploymentShutdownResponseDeploymentTemplateDefinitionRequestDeploymentTemplateInfoDeploymentTemplateInfoV2DeploymentTemplateMigrateResponseDeploymentTemplateReferenceDeploymentTemplateRequestBodyDeploymentUpdateMetadataDeploymentUpdateRequestDeploymentUpdateResourcesDeploymentUpdateResponseDeploymentUpdateSettingsDeploymentsListResponseDeploymentsListingDataDeploymentsSearchResponseDeprecatedElasticsearchClusterSettingsDiscreteSizesElasticsearchElasticsearchClusterBlockingIssueElementElasticsearchClusterBlockingIssuesElasticsearchClusterInfoElasticsearchClusterInstanceSettingsOverridesElasticsearchClusterPlanElasticsearchClusterPlanInfoElasticsearchClusterPlansInfoElasticsearchClusterRoleElasticsearchClusterSecurityInfoElasticsearchClusterSettingsElasticsearchClusterTopologyElementElasticsearchClusterTrustSettingsElasticsearchClusterUserElasticsearchClustersInfoElasticsearchConfigurationElasticsearchCurationElasticsearchDependantElasticsearchElasticUserPasswordResetResponseElasticsearchInfoElasticsearchMasterElementElasticsearchMasterInfoElasticsearchMonitoringInfoElasticsearchNodeTypeElasticsearchPayloadElasticsearchPlanControlConfigurationElasticsearchReplicaElementElasticsearchResourceInfoElasticsearchScriptTypeSettingsElasticsearchScriptingUserSettingsElasticsearchShardElementElasticsearchShardsInfoElasticsearchSystemSettingsElasticsearchUserBundleElasticsearchUserPluginElevatePermissionsRequestElevatedPermissionsEmptyResponseEnableIlmRequestEnrollmentTokenRequestEnterpriseSearchEnterpriseSearchConfigurationEnterpriseSearchInfoEnterpriseSearchNodeTypesEnterpriseSearchPayloadEnterpriseSearchPlanEnterpriseSearchPlanControlConfigurationEnterpriseSearchPlanInfoEnterpriseSearchPlansInfoEnterpriseSearchResourceInfoEnterpriseSearchSettingsEnterpriseSearchSubInfoEnterpriseSearchSystemSettingsEnterpriseSearchTopologyElementExistsQueryExtensionExtensionFileMetadataExtensionsExternalHyperlinkExternalTrustRelationshipFilterAssociationGlobalDeploymentTemplateInfoGlobalDeploymentTemplateRegionGrowShrinkStrategyConfigHyperlinkIdResponseIndexPatternIndexSynchronizationResultsInstanceConfigurationInstanceConfigurationInfoInstanceMoveRequestInstanceTypeResourceIpFilterRuleIpFilterRulesetIpFilterRulesetsIpFilteringSettingsKeystoreContentsKeystoreSecretKibanaKibanaClusterInfoKibanaClusterPlanKibanaClusterPlanInfoKibanaClusterPlansInfoKibanaClusterSettingsKibanaClusterTopologyElementKibanaClustersInfoKibanaConfigurationKibanaDeeplinkKibanaPayloadKibanaPlanControlConfigurationKibanaResourceInfoKibanaSubClusterInfoKibanaSystemSettingsLdapGroupSearchLdapSecurityRealmLoadBalanceLdapSecurityRealmRoleMappingRuleLdapSecurityRealmRoleMappingRulesLdapSettingsLdapUserSearchLegacySecuritySettingsLicenseInfoLicenseObjectListEnrollmentTokenElementListEnrollmentTokenReplyLoggingSettingsLoginRequestLoginStateManagedMonitoringSettingsMatchAllQueryMatchNoneQueryMatchQueryMetadataMetadataItemMetadataItemValueMetadataItemsModelVersionIndexSynchronizationResultsMoveApmClusterConfigurationMoveApmClusterDetailsMoveAppSearchConfigurationMoveAppSearchDetailsMoveClustersCommandResponseMoveClustersDetailsMoveClustersRequestMoveElasticsearchClusterConfigurationMoveElasticsearchClusterDetailsMoveEnterpriseSearchConfigurationMoveEnterpriseSearchDetailsMoveKibanaClusterConfigurationMoveKibanaClusterDetailsNestedQueryNodeTypeResourceNoteNotesOrphanedOrphanedElasticsearchPendingStatePendingStatesPendingStatesWithMetaPlanStrategyPlatformInfoPlatformResourcesSummaryPlatformServiceImageInfoPlatformServiceInfoPortBindingPrefixQueryProxiesAllocationsInfoProxiesFilterProxiesFilteredGroupProxiesFilteredGroupHealthProxiesHealthProxiesHttpSettingsProxiesSSOSettingsProxiesSettingsProxiesSummaryProxyAllocationCountsProxyAllocationInfoProxyInfoProxyOverviewProxySummaryPublicCertChainPublicCertChainCollectionQueryContainerQueryStringQueryRangeQueryReAuthenticationRequestReAuthenticationResponseReadOnlyRequestReadOnlyResponseRegionInfoRemoteClusterInfoRemoteClusterRefRemoteResourceRefRemoteResourcesReplyWarningRepositoryConfigRepositoryConfigsRequestEnrollmentTokenReplyRestartPolicyRestoreSnapshotApiConfigurationRestoreSnapshotConfigurationRestoreSnapshotRepoConfigurationRoleRoleAggregateRoleAggregateCreateDataRoleAggregatesRoleWithMetaRollingGrowShrinkStrategyConfigRollingStrategyConfigRuleSetResponseRulesetAssociationsRunnerBuildInfoRunnerContainerInfoRunnerInfoRunnerOverviewRunnerRoleInfoRunnerRolesInfoRunnersSummarySamlAttributeSettingsSamlIdpSettingsSamlSecurityRealmRoleMappingRuleSamlSecurityRealmRoleMappingRulesSamlSettingsSamlSpSettingsSearchRequestSecurityDeploymentSecurityDeploymentCreateRequestSecurityDeploymentTopologySecurityDeploymentUpdateRequestSecurityRealmInfoSecurityRealmInfoListSecurityRealmsReorderRequestSnapshotRepositoryConfigurationSnapshotStatusInfoSsoAuthenticationMethodInfoStackVersionApmConfigStackVersionAppSearchConfigStackVersionArchiveProcessingErrorStackVersionArchiveProcessingResultStackVersionConfigStackVersionConfigPostStackVersionConfigsStackVersionElasticsearchConfigStackVersionEnterpriseSearchConfigStackVersionInstanceCapacityConstraintStackVersionKibanaConfigStackVersionMetadataStackVersionNodeTypeStackVersionTemplateFileHashStackVersionTemplateInfoTargetElasticsearchClusterTelemetryConfigTelemetryConfigRequestTermQueryTiebreakerTopologyElementTlsPublicCertChainTokenResponseTopologySizeTrafficFilterRuleTrafficFilterRulesetInfoTrafficFilterRulesetRequestTrafficFilterRulesetResponseTrafficFilterRulesetsTrafficFilterSettingsTransientApmPlanConfigurationTransientAppSearchPlanConfigurationTransientElasticsearchPlanConfigurationTransientEnterpriseSearchPlanConfigurationTransientKibanaPlanConfigurationUnreachableRegionInfoUpdateExtensionRequestUpdatesUsageStatsUserUserApiKeyUserListUserMetadataUserSecurityUserSecurityRealmZookeeperNodeInfoZookeeperSummary
- Script reference
- Glossary
- Release notes
- Elastic Cloud Enterprise 2.7.2
- Elastic Cloud Enterprise 2.7.1
- Elastic Cloud Enterprise 2.7.0
- Elastic Cloud Enterprise 2.6.2
- Elastic Cloud Enterprise 2.6.1
- Elastic Cloud Enterprise 2.6.0
- Elastic Cloud Enterprise 2.5.1
- Elastic Cloud Enterprise 2.5.0
- Elastic Cloud Enterprise 2.4.3
- Elastic Cloud Enterprise 2.4.2
- Elastic Cloud Enterprise 2.4.1
- Elastic Cloud Enterprise 2.4.0
- Elastic Cloud Enterprise 2.3.2
- Elastic Cloud Enterprise 2.3.1
- Elastic Cloud Enterprise 2.3.0
- Elastic Cloud Enterprise 2.2.3
- Elastic Cloud Enterprise 2.2.2
- Elastic Cloud Enterprise 2.2.1
- Elastic Cloud Enterprise 2.2.0
- Elastic Cloud Enterprise 2.1.1
- Elastic Cloud Enterprise 2.1.0
- Elastic Cloud Enterprise 2.0.1
- Elastic Cloud Enterprise 2.0.0
- Elastic Cloud Enterprise 1.1.5
- Elastic Cloud Enterprise 1.1.4
- Elastic Cloud Enterprise 1.1.3
- Elastic Cloud Enterprise 1.1.2
- Elastic Cloud Enterprise 1.1.1
- Elastic Cloud Enterprise 1.1.0
- Elastic Cloud Enterprise 1.0.2
- Elastic Cloud Enterprise 1.0.1
- Elastic Cloud Enterprise 1.0.0
- What’s new with the Elastic Stack
- About this product
It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
RESTful API
editRESTful API
editA RESTful API is available with Elastic Cloud Enterprise to create and manage both your Elastic Stack deployments and the ECE platform:
- Authentication - How to authenticate when using the API endpoints.
- API calls - The API protocols and request methods.
-
Access the API from the Command Line - Use
curlto make your API requests. - Create an API client - Build a client in your favorite language to access the API.
- API Examples - Examples to get you started on your own automation journey.
- API Reference - Our OpenAPI-sourced reference content. Covers everything we support at a glance.
Was this helpful?
Thank you for your feedback.