# Elastic Query Rules API

**Canonical:** https://apis.io/apis/elastic/elastic-query-rules-api/  
**Provider:** Elastic — https://apis.io/providers/elastic/  
**Base URL:** https://api.elastic-cloud.com  
**Documentation:** https://www.elastic.co/docs/api/doc/elasticsearch

Elastic Query Rules API is one of 50 APIs that [Elastic](https://apis.io/providers/elastic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

Query rules enable you to configure per-query rules that are applied at query time to queries that match the specific rule. Query rules are organized into rulesets, collections of query rules that are matched against incoming queries. Query rules are applied using the rule query. If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching. This allows pinning documents for only queries that match a specific term. Alternatively, you can use the Query Rules UI to manage query rules.

## Operations (8)

| Method | Path | Summary |
|---|---|---|
| GET | `/_query_rules/{ruleset_id}/_rule/{rule_id}` | Get a query rule |
| PUT | `/_query_rules/{ruleset_id}/_rule/{rule_id}` | Create or update a query rule |
| DELETE | `/_query_rules/{ruleset_id}/_rule/{rule_id}` | Delete a query rule |
| GET | `/_query_rules/{ruleset_id}` | Get a query ruleset |
| PUT | `/_query_rules/{ruleset_id}` | Create or update a query ruleset |
| DELETE | `/_query_rules/{ruleset_id}` | Delete a query ruleset |
| GET | `/_query_rules` | Get all query rulesets |
| POST | `/_query_rules/{ruleset_id}/_test` | Test a query ruleset |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/openapi/elastic-query-rules-api-openapi.yml
- **Documentation** — https://www.elastic.co/docs/api/doc/elasticsearch
- **Documentation** — https://www.elastic.co/docs/api/doc/kibana
- **Documentation** — https://www.elastic.co/docs/api/doc/cloud
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/elastic/refs/heads/main/json-schema/elastic-saved-object-schema.json

## Other Elastic APIs (12)

- [Elastic Account API](https://apis.io/apis/elastic/elastic-account-api/)
- [Elastic Cluster API](https://apis.io/apis/elastic/elastic-cluster-api/)
- [Elastic Deployments API](https://apis.io/apis/elastic/elastic-deployments-api/)
- [Elastic Documents API](https://apis.io/apis/elastic/elastic-documents-api/)
- [Elastic Indices API](https://apis.io/apis/elastic/elastic-indices-api/)
- [Elastic Search API](https://apis.io/apis/elastic/elastic-search-api/)
- [Elastic Security API](https://apis.io/apis/elastic/elastic-security-api/)
- [Elastic Spaces API](https://apis.io/apis/elastic/elastic-spaces-api/)
- [Elastic Status API](https://apis.io/apis/elastic/elastic-status-api/)
- [Elastic TrafficFilters API](https://apis.io/apis/elastic/elastic-trafficfilters-api/)
- [Elastic Analytics API](https://apis.io/apis/elastic/elastic-analytics-api/)
- [Elastic Cat API](https://apis.io/apis/elastic/elastic-cat-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/elastic/elastic-query-rules-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/elastic/.