Skip to main content

Bucket

Definition​

Bucket Type
bucket.json
{
  "id": 0,
  "outerID": 0,
  "bucketName": "",
  "endpoint": "",
  "status": 0,
  "createdAt": "",
  "updatedAt": "",
}

Get Buckets​

curl -X GET "https://${baseUrl}/bucket/?\$filter=&\$orderBy=&\$page=1&\$pageSize=10" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Get Bucket​

curl -X GET "https://${baseUrl}/bucket/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Apply Bucket.ID​

curl -X POST "https://${baseUrl}/apply/bucket/id/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Create Bucket​

curl -X POST "https://${baseUrl}/bucket/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @bucket.json
info
bucket.json
{
  "outerID": 0,
  "bucketName": "",
  "endpoint": "",
  "status": 0,
}
tip

success status: 201

Update Bucket​

curl -X PUT "https://${baseUrl}/bucket/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @bucket.json
info
bucket.json
{
  "outerID": 0,
  "bucketName": "",
  "endpoint": "",
  "status": 0,
}

Update Bucket Partial​

curl -X PATCH "https://${baseUrl}/bucket/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -H "Attrs: outerID,bucketName,endpoint,status" \
   -d @bucket.json
info
bucket.json
{
  "outerID": 0,
  "bucketName": "",
  "endpoint": "",
  "status": 0,
}

Update Bucket Status​

curl -X PATCH "https://${baseUrl}/bucket/${id}/status/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @bucket.json
info
bucket.json
{
  "status": 0
}

Destroy Bucket​

curl -X DELETE "https://${baseUrl}/bucket/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"