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

OpenMetadata Queries API

A `Query` entity represents a SQL query associated with data assets it is run against.

OpenMetadata Queries API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Query. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 22 operations across 15 paths, and defines 29 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

22 operations 15 paths 29 schemas 5 DELETE6 GET2 PATCH1 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Queries API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 22

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

Queries 22

A Query entity represents a SQL query associated with data assets it is run against.

PUT
/v1/queries/{id}/followers
Add a follower
addFollower_10 1 param body → 200404
PUT
/v1/queries/{id}/usage
Add query usage
addQueryUsage 1 param body → 200
DELETE
/v1/queries/{id}/usage
remove query used in
removeQueryUsedIn 1 param body → 200
PUT
/v1/queries/{id}/usedBy
Populate Used By Field
addQueryUsedBy 1 param body → 200
PUT
/v1/queries/{id}/users
Add query users
addQueryUsers 1 param body → 200
PUT
/v1/queries/bulk
Bulk create or update queries
bulkCreateOrUpdateQueries 1 param body → 200202400
GET
/v1/queries
Get a list of Queries
listQueries 7 params → 200
PUT
/v1/queries
Create or update a query
createOrUpdateQuery body → 200400
POST
/v1/queries
Create a query
createQuery body → 200400
GET
/v1/queries/name/{fqn}
Get a query by name
getQueryFqn 2 params → 200404
DELETE
/v1/queries/name/{fqn}
Delete a query
deleteQueryByFQN 1 param → 200404
PATCH
/v1/queries/name/{fqn}
Update a query using name.
patchQuery 1 param body → default
GET
/v1/queries/{id}
Get a query
getQueryById 2 params → 200404
DELETE
/v1/queries/{id}
Delete a query
deleteQuery 1 param → 200404
PATCH
/v1/queries/{id}
Update a query
patchQuery_1 1 param body → default
DELETE
/v1/queries/async/{id}
Asynchronously delete a query
deleteQueryAsync 1 param → 200404
DELETE
/v1/queries/{id}/followers/{userId}
Remove a follower
deleteFollower_13 2 params → 200
GET
/v1/queries/{id}/versions/{version}
Get a specific version of the query
getSpecificQueryVersion 2 params → 200404
GET
/v1/queries/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_37 5 params → 200
GET
/v1/queries/{id}/versions
Get List of all query versions
listAllQueryVersion 1 param → 200
PUT
/v1/queries/restore
Restore a soft deleted Query
restore_28 body → 200
PUT
/v1/queries/{id}/vote
Update Vote for a Entity
updateVoteForEntity_13 1 param body → 200404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Query (42 properties), CreateQuery (22 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
Query
object
42 properties 4 required
BulkOperationResult
object
8 properties
CreateQuery
object
22 properties 2 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
VoteRequest
object
1 property
ResultList
object
5 properties 1 required
BulkResponse
object
3 properties
Paging
object
5 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required
QueryList
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-queries-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Queries 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.