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

> Create and manage API collections within an API service

# API Collections

An **API Collection** is a logical grouping of API endpoints within an API Service. It represents a set of related API operations.

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

## Entity Hierarchy

API Collections belong to an API Service and contain API Endpoints:

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

## Fully Qualified Name

The FQN format for an API collection is:

```
service.collectionName
```

For example: `sample_api_service.pet`

***

## API Endpoints

| Method   | Endpoint                                     | Description                                                                                          |
| -------- | -------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `PUT`    | `/v1/apiCollections`                         | [Create or update an API collection](/v1.12.x/api-reference/data-assets/api-collections/create)      |
| `POST`   | `/v1/apiCollections`                         | [Create an API collection (POST variant)](/v1.12.x/api-reference/data-assets/api-collections/create) |
| `GET`    | `/v1/apiCollections`                         | [List API collections](/v1.12.x/api-reference/data-assets/api-collections/list)                      |
| `GET`    | `/v1/apiCollections/{id}`                    | [Get by ID](/v1.12.x/api-reference/data-assets/api-collections/retrieve)                             |
| `GET`    | `/v1/apiCollections/name/{fqn}`              | [Get by FQN](/v1.12.x/api-reference/data-assets/api-collections/retrieve)                            |
| `PATCH`  | `/v1/apiCollections/{id}`                    | [Update by ID](/v1.12.x/api-reference/data-assets/api-collections/update)                            |
| `PATCH`  | `/v1/apiCollections/name/{fqn}`              | [Update by name](/v1.12.x/api-reference/data-assets/api-collections/update)                          |
| `DELETE` | `/v1/apiCollections/{id}`                    | [Delete by ID](/v1.12.x/api-reference/data-assets/api-collections/delete)                            |
| `DELETE` | `/v1/apiCollections/name/{fqn}`              | [Delete by name](/v1.12.x/api-reference/data-assets/api-collections/delete)                          |
| `PUT`    | `/v1/apiCollections/restore`                 | [Restore soft-deleted API collection](/v1.12.x/api-reference/data-assets/api-collections/delete)     |
| `GET`    | `/v1/apiCollections/{id}/versions`           | [List versions](/v1.12.x/api-reference/data-assets/api-collections/versions)                         |
| `GET`    | `/v1/apiCollections/{id}/versions/{version}` | [Get specific version](/v1.12.x/api-reference/data-assets/api-collections/versions)                  |