Retrieve existing Bucket by ID - Cynopsis API Documentation

Retrieve a specific bucket

curl --request GET \
  --url http://localhost/api/api/buckets/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": 123,
  "name": "<string>"
}

GET

api

buckets

{id}

Retrieve a specific bucket

curl --request GET \
  --url http://localhost/api/api/buckets/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": 123,
  "name": "<string>"
}

Users can view data for a specific bucket by specifying the id of the bucket.

Authorization

string

header

required

JWT token obtained from AWS Cognito or custom authentication service

integer

required

A unique integer value identifying this bucket.

200 - application/json

Bucket retrieved successfully.

Bucket information

integer

Bucket ID

name

string

Bucket name

Documentation Index