This API allows you to retrieve, view, delete, and manage DRM settings for containers associated with user accounts.

Endpoint OverviewCopied!

1. Retrieve All Containers for a UserCopied!

GET /users/{user_id}/containers

Retrieve all containers associated with the specified user.

• Path Parameters:

  • user_id (string, required) — Unique identifier for the user.

2. Retrieve Details of a Specific ContainerCopied!

GET /containers/{container_id}

Retrieve metadata (what are we retrieving) and detailed information about a specific container.

• Path Parameters:

  • container_id (string, required) — Unique identifier for the container.

3. Delete a ContainerCopied!

DELETE /containers/{container_id}

Delete a specific container by its ID.

• Path Parameters:

  • container_id (string, required) — Unique identifier for the container.

4. Retrieve DRM Rules for a ContainerCopied!

GET /containers/{container_id}/drm

Retrieve the Digital Rights Management (DRM) rules configured for a specific container.

• Path Parameters:

  • container_id (string, required) — Unique identifier for the container.

5. Update DRM Rules for a ContainerCopied!

PATCH /containers/{container_id}/drm

Modify the DRM settings of a container, including geo-restrictions, IP restrictions, time windows, allowed recipients, and more.

• Path Parameters:

  • container_id (string, required) — Unique identifier for the container.

• Body Parameters (JSON):

  • dynamic (boolean) — If DRM rules can be dynamically updated.

  • geo (object) — Geographic access controls.

  • ip (object) — IP address-based access controls.

  • opens (integer) — Maximum allowed opens.

  • time (object) — Start and end time window for access.

  • downloadable (boolean) — Whether content is downloadable.

  • recipients (array of strings) — List of allowed recipient emails.