How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) Query Rules API

The query_rules API from Elastic Stack (ELK Stack) — 4 operation(s) for query_rules.

Elastic Stack (ELK Stack) Query Rules API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://{elasticsearch_endpoint}.

8 operations 4 paths 13 schemas 2 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
License
Resource Areas
1

Paths & Operations 8

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

query_rules 8
GET
/_query_rules/{ruleset_id}/_rule/{rule_id}
Get a query rule
query-rules-get-rule 2 params → 200
PUT
/_query_rules/{ruleset_id}/_rule/{rule_id}
Create or update a query rule
query-rules-put-rule 2 params body → 200
DELETE
/_query_rules/{ruleset_id}/_rule/{rule_id}
Delete a query rule
query-rules-delete-rule 2 params → 200
GET
/_query_rules/{ruleset_id}
Get a query ruleset
query-rules-get-ruleset 1 param → 200
PUT
/_query_rules/{ruleset_id}
Create or update a query ruleset
query-rules-put-ruleset 1 param body → 200
DELETE
/_query_rules/{ruleset_id}
Delete a query ruleset
query-rules-delete-ruleset 1 param → 200
GET
/_query_rules
Get all query rulesets
query-rules-list-rulesets 2 params → 200
POST
/_query_rules/{ruleset_id}/_test
Test a query ruleset
query-rules-test 1 param body → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are query_rules._types.QueryRule (5 properties), query_rules.list_rulesets.QueryRulesetListItem (4 properties), query_rules._types.QueryRuleCriteria (3 properties), query_rules._types.QueryRuleActions (2 properties). Each schema is shown below with its type and property counts.

_types.Result
string
query_rules._types.QueryRuleCriteria
object
3 properties 1 required
query_rules._types.QueryRuleType
string
query_rules.list_rulesets.QueryRulesetListItem
object
4 properties 4 required
_types.AcknowledgedResponseBase
object
1 property 1 required
query_rules._types.QueryRuleActions
object
2 properties
_types.IndexName
string
_types.Id
string
query_rules._types.QueryRuleset
object
2 properties 2 required
query_rules._types.QueryRule
object
5 properties 4 required
query_rules.test.QueryRulesetMatchedRule
object
2 properties 2 required
_types.query_dsl.PinnedDoc
object
2 properties 1 required
query_rules._types.QueryRuleCriteriaType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-query-rules-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Query Rules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.