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

# Create an API Collection

> Create a new API collection within an API service

# Create an API Collection

Create a new API collection within an API service.

## Body Parameters

<ParamField body="name" type="string" required>
  Name of the API collection. Must be unique within the parent API service.
</ParamField>

<ParamField body="service" type="string" required>
  Fully qualified name of the parent APIService (e.g., `sample_api_service`).
</ParamField>

<ParamField body="endpointURL" type="string">
  Base URL for the API collection (e.g., `https://petstore3.swagger.io/#/pet`).
</ParamField>

<ParamField body="displayName" type="string">
  Human-readable display name for the API collection.
</ParamField>

<ParamField body="description" type="string">
  Description of the API collection in Markdown format.
</ParamField>

<ParamField body="owners" type="array">
  Array of owner references (users or teams) to assign to the API collection.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>

    <ParamField body="name" type="string">
      Name of the owner entity.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Fully qualified name of the domain to assign for governance purposes.
</ParamField>

<ParamField body="tags" type="array">
  Array of classification tags to apply to the API collection.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="extension" type="object">
  Custom property values defined by your organization's metadata schema.
</ParamField>

<RequestExample dropdown>
  ```python POST /v1/apiCollections theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import APICollections
  from metadata.generated.schema.api.data.createAPICollection import CreateAPICollectionRequest

  configure(
      host="https://your-company.open-metadata.org/api",
      jwt_token="your-jwt-token"
  )

  request = CreateAPICollectionRequest(
      name="pet",
      service="sample_api_service",
      endpointURL="https://petstore3.swagger.io/#/pet",
      description="Pet-related API endpoints"
  )

  api_collection = APICollections.create(request)
  print(f"Created: {api_collection.fullyQualifiedName}")
  ```

  ```java POST /v1/apiCollections theme={null}
  import static org.openmetadata.sdk.fluent.APICollections.*;

  // Create using builder pattern
  var apiCollection = APICollections.builder()
      .name("pet")
      .service("sample_api_service")
      .endpointURL("https://petstore3.swagger.io/#/pet")
      .description("Pet-related API endpoints")
      .create();
  ```

  ```bash POST /v1/apiCollections theme={null}
  curl -X POST "{base_url}/api/v1/apiCollections" \
    -H "Authorization: Bearer {access_token}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "pet",
      "service": "sample_api_service",
      "endpointURL": "https://petstore3.swagger.io/#/pet",
      "description": "Pet-related API endpoints"
    }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
    "name": "pet",
    "fullyQualifiedName": "sample_api_service.pet",
    "version": 0.1,
    "updatedAt": 1769982733673,
    "updatedBy": "admin",
    "endpointURL": "https://petstore3.swagger.io/#/pet",
    "href": "http://localhost:8585/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
    "owners": [],
    "tags": [],
    "service": {
      "id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
      "type": "apiService",
      "name": "sample_api_service",
      "fullyQualifiedName": "sample_api_service",
      "deleted": false
    },
    "serviceType": "Rest",
    "deleted": false,
    "domains": []
  }
  ```
</ResponseExample>

***

## Returns

Returns the created API collection object with all specified properties and system-generated fields.

## Response

<ResponseField name="id" type="string">
  Unique identifier for the API collection (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  API collection name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name in format `service.collectionName`.
</ResponseField>

<ResponseField name="displayName" type="string">
  Human-readable display name.
</ResponseField>

<ResponseField name="description" type="string">
  Description of the API collection in Markdown format.
</ResponseField>

<ResponseField name="endpointURL" type="string">
  Base URL for the API collection.
</ResponseField>

<ResponseField name="service" type="object">
  Reference to the parent API service.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      UUID of the API service.
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of entity (always `apiService`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the API service.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name of the API service.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="serviceType" type="string">
  Type of API service (e.g., Rest).
</ResponseField>

<ResponseField name="owners" type="array" optional>
  List of owners assigned to the API collection.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      UUID of the owner entity.
    </ResponseField>

    <ResponseField name="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the owner entity.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="domains" type="array" optional>
  Domain assignments for governance.
</ResponseField>

<ResponseField name="tags" type="array" optional>
  Classification tags applied to the API collection.

  <Expandable title="properties">
    <ResponseField name="tagFQN" type="string">
      Fully qualified name of the tag.
    </ResponseField>

    <ResponseField name="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ResponseField>

    <ResponseField name="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="extension" type="object" optional>
  Custom property values defined by your organization's metadata schema.
</ResponseField>

<ResponseField name="version" type="number">
  Version number for the entity (starts at 0.1).
</ResponseField>

***

## Create or Update (PUT)

Use `PUT /v1/apiCollections` instead of `POST` to perform an upsert. If an API collection with the same `fullyQualifiedName` already exists, it will be updated; otherwise, a new API collection is created. The request body is the same as `POST`.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/apiCollections" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'
```

<Note>
  `PUT` will not return a `409` conflict error if the entity already exists -- it will update the existing entity instead.
</Note>

***

## Bulk Create or Update (PUT)

Use `PUT /v1/apiCollections/bulk` to create or update multiple API collections in a single request. The request body is an array of create request objects.

```bash theme={null}
curl -X PUT "{base_url}/api/v1/apiCollections/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "pet", "service": "sample_api_service" },
    { "name": "store", "service": "sample_api_service" }
  ]'
```

***

## Error Handling

| Code  | Error Type              | Description                                                         |
| ----- | ----------------------- | ------------------------------------------------------------------- |
| `400` | `BAD_REQUEST`           | Invalid request body or missing required fields                     |
| `401` | `UNAUTHORIZED`          | Invalid or missing authentication token                             |
| `403` | `FORBIDDEN`             | User lacks permission to create API collections                     |
| `409` | `ENTITY_ALREADY_EXISTS` | API collection with same name already exists in service (POST only) |