OpenMetadata/openmetadata-docs/content/v1.9.x/main-concepts/metadata-standard/schemas/api/data/createAPICollection.md

title	description	slug
Create API Collection Schema | OpenMetadata API Data	Define a new API collection consisting of grouped API endpoints with shared access rules and data classification.	/main-concepts/metadata-standard/schemas/api/data/createapicollection

CreateAPICollectionRequest

Create API Collection entity request

Properties

• name: Name that identifies this API Collection. Refer to ../../type/basic.json#/definitions/entityName.
• displayName (string): Display Name that identifies this API Collection. It could be title or label from the source services.
• description: Description of the API Collection instance. What it has and how to use it. Refer to ../../type/basic.json#/definitions/markdown.
• endpointURL (string, format: uri): EndPoint URL for the API Collection. Capture the Root URL of the collection.
• apiEndpoints (array): All the API's fullyQualifiedNames included in this API Collection. Default: null.
  • Items: Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
• tags (array): Tags for this API Collection. Default: null.
  • Items: Refer to ../../type/tagLabel.json.
• owners: Owners of this API Collection. Refer to ../../type/entityReferenceList.json. Default: null.
• service: Link to the API service fully qualified name where this API collection is hosted in. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
• extension: Entity extension data with custom attributes added to the entity. Refer to ../../type/basic.json#/definitions/entityExtension.
• domain: Fully qualified name of the domain the API Collection belongs to. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
• dataProducts (array): List of fully qualified names of data products this entity is part of.
  • Items: Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
• lifeCycle: Life Cycle of the entity. Refer to ../../type/lifeCycle.json.
• sourceHash (string): Source hash of the entity.

Documentation file automatically generated at 2025-01-15 09:05:41.923720+00:00.