List Shared Links

Retrieve your own active shared links with pagination.
EndpointMethodAdmin Required
/api/v1/objects/shareGETNo

Returns a paginated list of shared links you've created, across all of your buckets.

Query Parameters

page
integer
Page number. Default: 1
per
integer
Items per page. Default: 10

Response

{
    "metadata": {
        "page": 1,
        "per": 10,
        "total": 1
    },
    "items": [
        {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "bucketName": "my-bucket",
            "key": "report.pdf",
            "url": "https://api.example.com/api/v1/shared/3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "expiresAt": "2025-01-15T13:00:00Z",
            "createdAt": "2025-01-15T12:00:00Z"
        }
    ]
}

Response Fields

id
string
Unique identifier of the shared link. Also the token used in url.
bucketName
string
Name of the bucket the shared object belongs to.
key
string
Key of the shared object.
url
string
The public, unauthenticated URL. See Share Object.
expiresAt
string
ISO 8601 timestamp of when the link stops working.
createdAt
string
ISO 8601 timestamp of when the link was created.

Share Object

Generate a temporary, unauthenticated link to download an object.

Revoke Shared Link

Revoke a shared link before it expires.