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 Apps API

Apps marketplace holds to application available for Open-metadata

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

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

This API exposes 39 operations across 29 paths, and defines 58 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.

39 operations 29 paths 58 schemas 6 DELETE18 GET4 PATCH7 POST4 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 Apps API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 39

Across 29 paths, the API surfaces 39 operations — 6 DELETE, 18 GET, 4 PATCH, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Apps 39

Apps marketplace holds to application available for Open-metadata

GET
/v1/apps/marketplace
List application
listApplications 5 params → 200
PUT
/v1/apps/marketplace
Create Or Update App
createOrUpdateApp body → 200
POST
/v1/apps/marketplace
Create a Application
createApplication body → 200400
GET
/v1/apps/marketplace/name/{name}
Get a App by name
getAppByName 3 params → 200404
DELETE
/v1/apps/marketplace/name/{name}
Delete a App by name
deleteAppByName 2 params → 200404
GET
/v1/apps/marketplace/{id}
Get a app by Id
get 3 params → 200404
DELETE
/v1/apps/marketplace/{id}
Delete a App by Id
deleteApp 2 params → 200404
PATCH
/v1/apps/marketplace/{id}
Updates a App
patchApplication_1 1 param body → default
DELETE
/v1/apps/marketplace/async/{id}
Asynchronously delete a App by Id
deleteAppAsync 2 params → 200404
GET
/v1/apps/marketplace/{id}/versions/{version}
Get a version of the App
getSpecificAppVersion 2 params → 200404
GET
/v1/apps/marketplace/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_7 5 params → 200
GET
/v1/apps/marketplace/{id}/versions
List Installed Application versions
listAllInstalledApplications 1 param → 200
PATCH
/v1/apps/marketplace/name/{fqn}
Updates an App by name.
patchApplication 1 param body → default
PUT
/v1/apps/marketplace/restore
Restore a soft deleted KPI
restore_6 body → 200
POST
/v1/apps/configure/{name}
Configure an Application
configureApplication 1 param → 200404
GET
/v1/apps
List installed application
listInstalledApplications 6 params → 200
PUT
/v1/apps
Create Or Update App
createOrUpdateApp_1 body → 200
POST
/v1/apps
Create a Application
createApplication_1 body → 200400
GET
/v1/apps/name/{name}
Get a App by name
getAppByName_1 3 params → 200404
DELETE
/v1/apps/name/{name}
Delete a App by name
uninstallAppByName 2 params → 200400404
GET
/v1/apps/{id}
Get a app by Id
get_1 3 params → 200404
DELETE
/v1/apps/{id}
Delete a App by Id
uninstallAppByName_1 2 params → 200400404
PATCH
/v1/apps/{id}
Updates a App
patchApplication_3 1 param body → default
DELETE
/v1/apps/async/{id}
Asynchronously delete a App by Id
uninstallAppByNameAsync 2 params → 200400404
POST
/v1/apps/deploy/{name}
Deploy App to Quartz or Ingestion
deployApplicationToQuartzOrIngestion 1 param → 200404
GET
/v1/apps/name/{name}/logs
Retrieve all logs from last ingestion pipeline run for the application
getLastLogs 4 params → 200404
GET
/v1/apps/{id}/versions/{version}
Get a version of the App
getSpecificAppVersion_1 2 params → 200404
GET
/v1/apps/installed
List Entity Reference for installed application
listInstalledAppsInformation → 200
GET
/v1/apps/name/{name}/extension
List App Extension data
listAppExtension 6 params → 200
GET
/v1/apps/name/{name}/status
List App Run Records
listAppRunRecords 5 params → 200
GET
/v1/apps/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_8 5 params → 200
GET
/v1/apps/name/{name}/runs/latest
Get Latest App Run Record
latestAppRunRecord 2 params → 200
GET
/v1/apps/name/{name}/live-indexing-queue
List Search Index Retry Queue
listSearchIndexRetryQueue 3 params → 200
GET
/v1/apps/{id}/versions
List Installed Application versions
listAllInstalledApplications_1 1 param → 200
PATCH
/v1/apps/name/{fqn}
Updates a App by name.
patchApplication_2 1 param body → default
PUT
/v1/apps/restore
Restore a soft deleted KPI
restore_7 body → 200
POST
/v1/apps/schedule/{name}
Schedule an Application
scheduleApplication 1 param → 200404
POST
/v1/apps/stop/{name}
Stop a Application run
stopApplicationRun 2 params → 200404
POST
/v1/apps/trigger/{name}
Trigger an Application run
triggerApplicationRun 1 param body → 200404

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are App (59 properties), AppMarketPlaceDefinition (54 properties), OpenMetadataConnection (34 properties), CreateAppMarketPlaceDefinitionReq (33 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
CreateEventSubscription
object
23 properties 2 required
StatusType
object
3 properties
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
EntityStats
object
AppList
object
5 properties 1 required
RestoreEntity
object
1 property 1 required
Response
object
17 properties
Link
object
7 properties
LifeCycle
object
3 properties
FilterPattern
object
2 properties
TriggerConfig
object
3 properties 1 required
OpenMetadataConnection
object
34 properties 1 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
AppRunRecord
object
15 properties
AppSchedule
object
2 properties 1 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
ComponentConfig
object
AppMarketPlaceDefinitionList
object
5 properties 1 required
UriBuilder
object
AppExtension
object
4 properties 3 required
JsonPatch
object
StepStats
object
11 properties
ChangeDescription
object
5 properties
AppRunList
object
5 properties 1 required
ElasticsSearch
object
2 properties 1 required
NewCookie
object
11 properties
AlertFilteringInput
object
2 properties
ArgumentsInput
object
4 properties
MediaType
object
5 properties
App
object
59 properties 7 required
Argument
object
2 properties
UsageStats
object
2 properties 1 required
SubscriptionDestination
object
10 properties 2 required
Stats
object
6 properties
Style
object
3 properties
Votes
object
4 properties
AppRefList
object
5 properties 1 required
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
EntityTag
object
2 properties
ExtraHeaders
object
FailureContext
object
1 property
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
IndexingError
object
9 properties
SuccessContext
object
1 property
CreateApp
object
16 properties
EntityReference
object
9 properties 2 required
OpenMetadataJWTClientConfig
object
1 property 1 required
CreateAppMarketPlaceDefinitionReq
object
33 properties 5 required
UsageDetails
object
4 properties 2 required
AppMarketPlaceDefinition
object
54 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-apps-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 Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
OpenMetadata Columns API
Where this information came from

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