A Bucket is an object representing a group of API key consumers for a given account. This section includes a group of endpoints available to perform CRUD operations on a bucket. You can learn more about buckets here.
Lists buckets
Lists all buckets belonging to this account.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
Lists buckets › Responses
The request has succeeded.
limitoffsettotalCreates a bucket
Creates a new bucket for this account.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
Creates a bucket › Request Body
name^[a-z0-9-]{5,128}$ · requiredA friendly name for the bucket.
descriptionA description of the bucket.
Key value pairs to associate with the bucket.
Creates a bucket › Responses
The request has succeeded.
createdOnWhen the item was created.
updatedOnWhen the item was last updated.
idname^[a-z0-9-]{5,128}$ · requiredA friendly name for the bucket.
isRetrievableWhether the API keys stored in the bucket are retrievable
descriptionA description of the bucket.
Key value pairs to associate with the bucket.
Gets a bucket
Returns the details for a bucket, including the token used to connect to the bucket.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
Gets a bucket › Responses
The request has succeeded.
createdOnWhen the item was created.
updatedOnWhen the item was last updated.
idname^[a-z0-9-]{5,128}$ · requiredA friendly name for the bucket.
isRetrievableWhether the API keys stored in the bucket are retrievable
descriptionA description of the bucket.
Key value pairs to associate with the bucket.
Deletes a bucket
Deletes a bucket and any related resources
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
Deletes a bucket › Responses
There is no content to send for this request, but the headers may be useful.
Updates a bucket
Updates a bucket, and returns the updated value.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
Updates a bucket › Request Body
descriptionA description of the bucket.
Key value pairs to associate with the bucket.
Updates a bucket › Responses
The request has succeeded.
createdOnWhen the item was created.
updatedOnWhen the item was last updated.
idname^[a-z0-9-]{5,128}$ · requiredA friendly name for the bucket.
isRetrievableWhether the API keys stored in the bucket are retrievable
descriptionA description of the bucket.
Key value pairs to associate with the bucket.