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

# Containers

> Create and manage containers within a storage service

# Containers

A **Container** represents a storage bucket or directory (e.g., an S3 bucket, GCS bucket, or ADLS container). Containers belong to a Storage Service and can be nested to represent folder hierarchies.

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

## Entity Hierarchy

Containers belong to a Storage Service and can be nested:

<CodeGroup>
  ```txt Container theme={null}
  StorageService
  └── Container (this page)
      └── Container (nested child)
  ```
</CodeGroup>

## Fully Qualified Name

The FQN format for a container is:

```
service.containerName
```

For nested containers:

```
service.parentContainer.childContainer
```

For example: `s3_datalake.analytics-bucket` or `s3_datalake.analytics-bucket.raw-data`

***

## API Endpoints

| Method   | Endpoint                                 | Description                                                                               |
| -------- | ---------------------------------------- | ----------------------------------------------------------------------------------------- |
| `PUT`    | `/v1/containers`                         | [Create or update a container](/v1.12.x/api-reference/data-assets/containers/create)      |
| `POST`   | `/v1/containers`                         | [Create a container (POST variant)](/v1.12.x/api-reference/data-assets/containers/create) |
| `GET`    | `/v1/containers`                         | [List containers](/v1.12.x/api-reference/data-assets/containers/list)                     |
| `GET`    | `/v1/containers/{id}`                    | [Get by ID](/v1.12.x/api-reference/data-assets/containers/retrieve)                       |
| `GET`    | `/v1/containers/name/{fqn}`              | [Get by FQN](/v1.12.x/api-reference/data-assets/containers/retrieve)                      |
| `PATCH`  | `/v1/containers/{id}`                    | [Update by ID](/v1.12.x/api-reference/data-assets/containers/update)                      |
| `PATCH`  | `/v1/containers/name/{fqn}`              | [Update by name](/v1.12.x/api-reference/data-assets/containers/update)                    |
| `DELETE` | `/v1/containers/{id}`                    | [Delete by ID](/v1.12.x/api-reference/data-assets/containers/delete)                      |
| `DELETE` | `/v1/containers/name/{fqn}`              | [Delete by name](/v1.12.x/api-reference/data-assets/containers/delete)                    |
| `PUT`    | `/v1/containers/restore`                 | [Restore soft-deleted container](/v1.12.x/api-reference/data-assets/containers/delete)    |
| `GET`    | `/v1/containers/{id}/versions`           | [List versions](/v1.12.x/api-reference/data-assets/containers/versions)                   |
| `GET`    | `/v1/containers/{id}/versions/{version}` | [Get specific version](/v1.12.x/api-reference/data-assets/containers/versions)            |
| `PUT`    | `/v1/containers/{id}/followers`          | [Add follower](/v1.12.x/api-reference/data-assets/containers/versions)                    |
| `DELETE` | `/v1/containers/{id}/followers/{userId}` | [Remove follower](/v1.12.x/api-reference/data-assets/containers/versions)                 |
| `PUT`    | `/v1/containers/{id}/vote`               | [Add/update vote](/v1.12.x/api-reference/data-assets/containers/versions)                 |