API Collections

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

Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

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

APIService
└── APICollection (this page)
    └── APIEndpoint

The FQN format for an API collection is:

service.collectionName

For example: sample_api_service.pet

Method	Endpoint	Description
`PUT`	`/v1/apiCollections`	Create or update an API collection
`POST`	`/v1/apiCollections`	Create an API collection (POST variant)
`GET`	`/v1/apiCollections`	List API collections
`GET`	`/v1/apiCollections/{id}`	Get by ID
`GET`	`/v1/apiCollections/name/{fqn}`	Get by FQN
`PATCH`	`/v1/apiCollections/{id}`	Update by ID
`PATCH`	`/v1/apiCollections/name/{fqn}`	Update by name
`DELETE`	`/v1/apiCollections/{id}`	Delete by ID
`DELETE`	`/v1/apiCollections/name/{fqn}`	Delete by name
`PUT`	`/v1/apiCollections/restore`	Restore soft-deleted API collection
`GET`	`/v1/apiCollections/{id}/versions`	List versions
`GET`	`/v1/apiCollections/{id}/versions/{version}`	Get specific version

⌘I