Get Container Metadata

The Get Container Metadata endpoint returns metadata for a specific container.

This allows your application to verify that a container exists, retrieve its status, and access container properties.

This endpoint does not return decrypted file contents.

Endpoint

GET /users/{user_id}/containers/{container_id}

Base URL:

https://share.locktera.com/api/v1

Full request URL example:

https://share.locktera.com/api/v1/users/USER_ID/containers/CONTAINER_ID

Authentication

All requests must include a valid API key in the Authorization header.

Example:

curl -X GET $BASE_URL/users/YOUR_USER_ID/containers/CONTAINER_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Authentication is verified before any container metadata is returned.

Path Parameters

container_id
Required. The unique identifier of the container.

Example:

123e4567-e89b-12d3-a456-426614174000

Example Success Response

{
  "container": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "example_container"
    // ...
  }
}

Response Fields

container_id
Unique identifier of the container.

container_name
Name assigned when the container was created.

created_at
Timestamp when the container was created.

created_by
User who created the container.

Example Error Responses

HTTP 404 Not Found

{
  "error": "not_found",
  "message": "Container not found"
}

HTTP 401 Unauthorized

{
  "error": "unauthorized",
  "message": "Invalid API key"
}

HTTP 403 Forbidden

{
  "error": "access_denied",
  "message": "You do not have permission to access this container"
}

What This Endpoint Is Used For

This endpoint is commonly used to:

• Verify that a container exists
• Retrieve container metadata
• Confirm container creation
• Check container status
• Validate container ownership

Important Notes

• This endpoint returns metadata only
• It does not return encrypted or decrypted file contents
• Container contents can only be accessed using the Decode endpoint
• A valid API key with appropriate permissions is required

Container metadata is cryptographically associated with the container and cannot be modified without creating a new container or updating DRM policies.

Related Endpoints

Encode Container

POST /users/{user_id}/containers/encode

Decode Container Manifest

GET /users/{user_id}/containers/{container_id}/decode

Decode Container Content

GET /users/{user_id}/containers/{container_id}/decode/{file_name}

Retrieve Audit Logs

GET /users/{user_id}/containers/{container_id}/events