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 Security Services API

APIs related to Security Service entities, such as Apache Ranger.

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

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

This API exposes 21 operations across 16 paths, and defines 31 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.

21 operations 16 paths 31 schemas 4 DELETE8 GET2 PATCH1 POST6 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 Security Services API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 21

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

Security Services 21

APIs related to Security Service entities, such as Apache Ranger.

PUT
/v1/services/securityServices/{id}/followers
Add a follower
addFollowerToSecurityService 1 param body → 200404
PUT
/v1/services/securityServices/{id}/testConnectionResult
Add test connection result
addTestConnectionResult_11 1 param body → 200
GET
/v1/services/securityServices
List security services
listSecurityServices 6 params → 200400
PUT
/v1/services/securityServices
Update security service
createOrUpdateSecurityService body → 200400
POST
/v1/services/securityServices
Create security service
createSecurityService body → 200400
GET
/v1/services/securityServices/name/{name}
Get security service by name
getSecurityServiceByFQN 4 params → 200404
DELETE
/v1/services/securityServices/name/{name}
Delete a security service by name
deleteSecurityServiceByName 3 params → 200404
GET
/v1/services/securityServices/{id}
Get a security service
getSecurityServiceByID 4 params → 200404
DELETE
/v1/services/securityServices/{id}
Delete a security service by Id
deleteSecurityService 3 params → 200404
PATCH
/v1/services/securityServices/{id}
Update a security service
patchSecurityService_1 1 param body → default
DELETE
/v1/services/securityServices/async/{id}
Asynchronously delete a security service by Id
deleteSecurityServiceAsync 3 params → 200404
DELETE
/v1/services/securityServices/{id}/followers/{userId}
Remove a follower
deleteFollower_26 2 params → 200
GET
/v1/services/securityServices/name/{name}/export
Export security service in CSV format
exportSecurityServices 1 param → 200
GET
/v1/services/securityServices/name/{name}/exportAsync
Export security service in CSV format
exportSecurityService 1 param → 200
GET
/v1/services/securityServices/{id}/versions/{version}
Get a version of the security service
getSpecificSecurityServiceVersion 2 params → 200404
PUT
/v1/services/securityServices/name/{name}/import
Import service from CSV to update security service (no creation allowed)
importSecurityService 2 params body → 200
PUT
/v1/services/securityServices/name/{name}/importAsync
Import service from CSV to update security service asynchronously (no creation allowed)
importSecurityServiceAsync 2 params body → 200
GET
/v1/services/securityServices/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_52 5 params → 200
GET
/v1/services/securityServices/{id}/versions
List security service versions
listAllSecurityServiceVersion 1 param → 200
PATCH
/v1/services/securityServices/name/{fqn}
Update a security service using name.
patchSecurityService 1 param body → default
PUT
/v1/services/securityServices/restore
Restore a soft deleted security service
restore_42 body → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SecurityService (36 properties), ChangeEvent (14 properties), CreateSecurityService (13 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
FieldChange
object
3 properties
CoverImage
object
2 properties
SecurityServiceList
object
5 properties 1 required
RestoreEntity
object
1 property 1 required
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
TestConnectionResult
object
3 properties 1 required
JsonPatch
object
SecurityConnection
object
1 property
ChangeDescription
object
5 properties
CSVExportResponse
object
2 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
Style
object
3 properties
Votes
object
4 properties
CsvImportResult
object
7 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
CreateSecurityService
object
13 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
TestConnectionStepResult
object
5 properties 3 required
EntityReference
object
9 properties 2 required
SecurityService
object
36 properties 3 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-security-services-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 Security Services 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.