Qodex.ai
Qodex.ai
Introduction
Elastic Cloud API
deployments-{deployment id}-elasticsearch/{ref id}-remote-clusters
Set remote clustersGet remote clusters
deployments-{deployment id}-elasticsearch/{ref id}-keystore
Add or remove settings from the Elasticsearch resource keystoreGet the settings from the Elasticsearch resource keystore
deployments-{deployment id}-elasticsearch/{ref id}
Get Deployment Elasticsearch Resource InfoShutdown Deployment Elasticsearch ResourceRestart Deployment Elasticsearch ResourceMigrate Elasticsearch resource to use SLMReset 'elastic' user passwordMigrate Elasticsearch and associated Kibana resources to enable CCRGet eligible remote clustersMigrate Elasticsearch resource to use ILM
deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}-maintenance-mode
Start maintenance modeStop maintenance mode
deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}
Stop instancesStart instances
deployments-{deployment id}-{resource kind}/{ref id}-instances-maintenance-mode
Start maintenance mode (all instances)Stop maintenance mode (all instances)
deployments-{deployment id}-{resource kind}/{ref id}-instances
Start all instancesStop all instances
deployments-{deployment id}-{resource kind}/{ref id}
Restores a shutdown resourceCancel resource pending plan
deployments-{deployment id}-apm/{ref id}
Get Deployment APM Resource InfoReset the secret token for an APM resource.
deployments-{deployment id}-appsearch/{ref id}-read only mode
Set AppSearch read-only statusSet AppSearch read-only status
deployments-{deployment id}-appsearch/{ref id}
Get Deployment App Search Resource Info
deployments-{deployment id}-{stateless resource kind}/{ref id}
Restart Deployment Stateless ResourceShutdown Deployment Stateless ResourceUpgrade Kibana, APM, AppSearch inside Deployment
deployments-{deployment id}
Update DeploymentGet DeploymentRestores a shutdown DeploymentGet Deployment Enterprise Search Resource InfoGet Deployment Kibana Resource InfoShuts down DeploymentBuild Migrate Deployment Template request
deployments-templates
Get deployment templatesGet deployment template
deployments-traffic-filter-rulesets-{ruleset id}-associations
Create ruleset associationGet associated deploymentsDelete ruleset association
deployments-traffic-filter-rulesets-{ruleset id}
Updates a rulesetDelete a rulesetRetrieves the ruleset by ID.
deployments-traffic-filter-rulesets
Create a rulesetList traffic filter rulesets
deployments-traffic-filter
Get associated rulesets
deployments-extensions-{extension id}
Uploads the ExtensionUpdate ExtensionDelete ExtensionGet Extension
deployments-extensions
Create an extensionList Extensions
deployments
Create DeploymentList DeploymentsSearch DeploymentsGet eligible remote clusters
users/auth/keys-{api key id}
Delete API keyGet API key
users/auth/keys
Create API keyDelete API keysGet all API keys
account
Updates the current accountUpdates the current accountFetch current account information
platform/configuration/trust-relationships-{trust relationship id}
Update trust relationshipDelete trust relationshipGet trust relationship
platform/configuration/trust-relationships
Create trust relationshipList trust relationships
Get stack versions
Introduction
Elastic Cloud API
deployments-{deployment id}-elasticsearch/{ref id}-remote-clusters
Set remote clustersGet remote clusters
deployments-{deployment id}-elasticsearch/{ref id}-keystore
Add or remove settings from the Elasticsearch resource keystoreGet the settings from the Elasticsearch resource keystore
deployments-{deployment id}-elasticsearch/{ref id}
Get Deployment Elasticsearch Resource InfoShutdown Deployment Elasticsearch ResourceRestart Deployment Elasticsearch ResourceMigrate Elasticsearch resource to use SLMReset 'elastic' user passwordMigrate Elasticsearch and associated Kibana resources to enable CCRGet eligible remote clustersMigrate Elasticsearch resource to use ILM
deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}-maintenance-mode
Start maintenance modeStop maintenance mode
deployments-{deployment id}-{resource kind}/{ref id}-instances-{instance ids}
Stop instancesStart instances
deployments-{deployment id}-{resource kind}/{ref id}-instances-maintenance-mode
Start maintenance mode (all instances)Stop maintenance mode (all instances)
deployments-{deployment id}-{resource kind}/{ref id}-instances
Start all instancesStop all instances
deployments-{deployment id}-{resource kind}/{ref id}
Restores a shutdown resourceCancel resource pending plan
deployments-{deployment id}-apm/{ref id}
Get Deployment APM Resource InfoReset the secret token for an APM resource.
deployments-{deployment id}-appsearch/{ref id}-read only mode
Set AppSearch read-only statusSet AppSearch read-only status
deployments-{deployment id}-appsearch/{ref id}
Get Deployment App Search Resource Info
deployments-{deployment id}-{stateless resource kind}/{ref id}
Restart Deployment Stateless ResourceShutdown Deployment Stateless ResourceUpgrade Kibana, APM, AppSearch inside Deployment
deployments-{deployment id}
Update DeploymentGet DeploymentRestores a shutdown DeploymentGet Deployment Enterprise Search Resource InfoGet Deployment Kibana Resource InfoShuts down DeploymentBuild Migrate Deployment Template request
deployments-templates
Get deployment templatesGet deployment template
deployments-traffic-filter-rulesets-{ruleset id}-associations
Create ruleset associationGet associated deploymentsDelete ruleset association
deployments-traffic-filter-rulesets-{ruleset id}
Updates a rulesetDelete a rulesetRetrieves the ruleset by ID.
deployments-traffic-filter-rulesets
Create a rulesetList traffic filter rulesets
deployments-traffic-filter
Get associated rulesets
deployments-extensions-{extension id}
Uploads the ExtensionUpdate ExtensionDelete ExtensionGet Extension
deployments-extensions
Create an extensionList Extensions
deployments
Create DeploymentList DeploymentsSearch DeploymentsGet eligible remote clusters
users/auth/keys-{api key id}
Delete API keyGet API key
users/auth/keys
Create API keyDelete API keysGet all API keys
account
Updates the current accountUpdates the current accountFetch current account information
platform/configuration/trust-relationships-{trust relationship id}
Update trust relationshipDelete trust relationshipGet trust relationship
platform/configuration/trust-relationships
Create trust relationshipList trust relationships
Get stack versions
HomeElastic Cloud APIusers/auth/keys

users/auth/keys

Number of APIs: 3

  1. Create API key POST {{baseUrl}}/users/auth/keys

  2. Delete API keys DELETE {{baseUrl}}/users/auth/keys

  3. Get all API keys GET {{baseUrl}}/users/auth/keys

Previous
Get API key
Next
Create API key