> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# API Endpoints

> Create and manage API endpoints within an API collection

# 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.

<Info>
  Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/data-assets/apis/api-endpoint/).
</Info>

## Entity Hierarchy

API Endpoints belong to an API Collection:

<CodeGroup>
  ```txt API Endpoint theme={null}
  APIService
  └── APICollection
      └── APIEndpoint (this page)
  ```
</CodeGroup>

## 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](/v1.12.x/api-reference/data-assets/api-endpoints/create)      |
| `POST`   | `/v1/apiEndpoints`                         | [Create an API endpoint (POST variant)](/v1.12.x/api-reference/data-assets/api-endpoints/create) |
| `GET`    | `/v1/apiEndpoints`                         | [List API endpoints](/v1.12.x/api-reference/data-assets/api-endpoints/list)                      |
| `GET`    | `/v1/apiEndpoints/{id}`                    | [Get by ID](/v1.12.x/api-reference/data-assets/api-endpoints/retrieve)                           |
| `GET`    | `/v1/apiEndpoints/name/{fqn}`              | [Get by FQN](/v1.12.x/api-reference/data-assets/api-endpoints/retrieve)                          |
| `PATCH`  | `/v1/apiEndpoints/{id}`                    | [Update by ID](/v1.12.x/api-reference/data-assets/api-endpoints/update)                          |
| `PATCH`  | `/v1/apiEndpoints/name/{fqn}`              | [Update by name](/v1.12.x/api-reference/data-assets/api-endpoints/update)                        |
| `DELETE` | `/v1/apiEndpoints/{id}`                    | [Delete by ID](/v1.12.x/api-reference/data-assets/api-endpoints/delete)                          |
| `DELETE` | `/v1/apiEndpoints/name/{fqn}`              | [Delete by name](/v1.12.x/api-reference/data-assets/api-endpoints/delete)                        |
| `PUT`    | `/v1/apiEndpoints/restore`                 | [Restore soft-deleted API endpoint](/v1.12.x/api-reference/data-assets/api-endpoints/delete)     |
| `GET`    | `/v1/apiEndpoints/{id}/versions`           | [List versions](/v1.12.x/api-reference/data-assets/api-endpoints/versions)                       |
| `GET`    | `/v1/apiEndpoints/{id}/versions/{version}` | [Get specific version](/v1.12.x/api-reference/data-assets/api-endpoints/versions)                |