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

Method	Endpoint	Description
`PUT`	`/v1/apiEndpoints`	Create or update an API endpoint
`POST`	`/v1/apiEndpoints`	Create an API endpoint (POST variant)
`GET`	`/v1/apiEndpoints`	List 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/restore`	Restore soft-deleted API endpoint
`GET`	`/v1/apiEndpoints/{id}/versions`	List versions
`GET`	`/v1/apiEndpoints/{id}/versions/{version}`	Get specific version

API Collection Versions

Create an API Endpoint

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

API Endpoints

API Endpoints

Entity Hierarchy

Fully Qualified Name

API Endpoints

​API Endpoints

​Entity Hierarchy

​Fully Qualified Name

​API Endpoints

API Endpoints

Entity Hierarchy

Fully Qualified Name

API Endpoints