API SpecificationBuckets
List buckets
Retrieves all buckets owned by or shared with the authenticated user, including shared resource access.
Authorization
OAuth2 upl:bucket:readAuthorizationBearer <token>
OAuth 2.0 authorization
In: header
Scope: upl:bucket:read
Header Parameters
Connect-Protocol-Version*number
Define the version of the Connect protocol
Value in
1Connect-Timeout-Ms?number
Define the timeout, in ms
Request Body
application/json
includeLatestUploads?integer
Format
int32Range
value <= 100includeAliasStatus?boolean
Include detailed alias status information for each bucket
hasFile?
Filter to only return buckets where this file exists
[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.BucketsService/ListBuckets" \ -H "Connect-Protocol-Version: 1" \ -H "Content-Type: application/json" \ -d '{}'{
"buckets": [
{
"bucket": {
"bucketId": "string",
"bucketName": "string",
"url": "string",
"uploadCount": 0,
"usedSpaceBytes": 0,
"totalSpaceBytes": 0,
"aliases": [
"string"
],
"isPrimary": true,
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z",
"type": "BUCKET_TYPE_UNSPECIFIED",
"destination": "BUCKET_DESTINATION_UNSPECIFIED",
"destinationConfig": {
"s3Bucket": {
"bucketName": "example.com",
"region": "string",
"roleArn": "string"
}
},
"primaryAlias": "string",
"portalConfig": {
"cdnMode": true
}
},
"permissionLevel": "BUCKET_PERMISSION_LEVEL_UNSPECIFIED",
"isPrimaryOwner": true,
"latestUploads": [
{
"uploadId": "string",
"url": "string",
"thumbnailUrl": "string",
"oauthClientId": "6d6c655c-ec4d-46c8-93fc-cca588313cab"
}
],
"parentClientId": "4706aefa-7ccb-4fc8-b88f-7337ad8d97a8",
"parentApplicationId": "8ca2af9c-7622-464d-8039-441aaac15487",
"aliasStatus": [
{
"alias": "string",
"isCustomDomain": true,
"status": "string",
"verifiedAt": "2023-01-15T01:30:15.01Z",
"error": "string",
"createdAt": "2023-01-15T01:30:15.01Z",
"fallbackHostname": "string"
}
]
}
],
"sharedResources": [
{
"bucket": {
"bucketId": "string",
"bucketName": "string",
"url": "string",
"uploadCount": 0,
"usedSpaceBytes": 0,
"totalSpaceBytes": 0,
"aliases": [
"string"
],
"isPrimary": true,
"createdAt": "2023-01-15T01:30:15.01Z",
"updatedAt": "2023-01-15T01:30:15.01Z",
"type": "BUCKET_TYPE_UNSPECIFIED",
"destination": "BUCKET_DESTINATION_UNSPECIFIED",
"destinationConfig": {
"s3Bucket": {
"bucketName": "example.com",
"region": "string",
"roleArn": "string"
}
},
"primaryAlias": "string",
"portalConfig": {
"cdnMode": true
}
},
"permissionLevel": "BUCKET_PERMISSION_LEVEL_UNSPECIFIED",
"sharedBy": {
"id": "string",
"username": "string"
},
"sharedAt": "2023-01-15T01:30:15.01Z",
"permissionId": "string",
"folder": {
"folderId": "string",
"path": "string",
"revokedSubpaths": [
"string"
]
}
}
]
}{
"code": "not_found",
"message": "string",
"details": [
{
"type": "string",
"value": "string",
"debug": {}
}
]
}