Skip to main content

​
API Endpoints

An API Endpoint represents a single API operation within an API Collection. It captures the request method, URL, request/response schemas, and other metadata.
Entity schema follows the OpenMetadata Standard.

​
Entity Hierarchy

API Endpoints belong to an API Collection: 
APIService
└── APICollection
    └── APIEndpoint (this page)

​
Fully Qualified Name

The FQN format for an API endpoint is: 
service.collection.endpointName
For example: sample_api_service.pet.addPet

​
API Endpoints

MethodEndpointDescription
PUT/v1/apiEndpointsCreate or update an API endpoint
POST/v1/apiEndpointsCreate an API endpoint (POST variant)
GET/v1/apiEndpointsList API endpoints
GET/v1/apiEndpoints/{id}Get by ID
GET/v1/apiEndpoints/name/{fqn}Get by FQN
PATCH/v1/apiEndpoints/{id}Update by ID
PATCH/v1/apiEndpoints/name/{fqn}Update by name
DELETE/v1/apiEndpoints/{id}Delete by ID
DELETE/v1/apiEndpoints/name/{fqn}Delete by name
PUT/v1/apiEndpoints/restoreRestore soft-deleted API endpoint
GET/v1/apiEndpoints/{id}/versionsList versions
GET/v1/apiEndpoints/{id}/versions/{version}Get specific version