API SpecificationBuckets
Get bucket
Retrieves details for a specific bucket including configuration, aliases, and portal settings.
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
bucketRef?|
Reference to the bucket
includeAliasStatus?boolean
Include detailed alias status information
[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.BucketsService/GetBucket" \ -H "Connect-Protocol-Version: 1" \ -H "Content-Type: application/json" \ -d '{}'{
"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,
"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"
}
]
}{
"code": "not_found",
"message": "string",
"details": [
{
"type": "string",
"value": "string",
"debug": {}
}
]
}