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
Creates a bucket
Creates a new bucket for this account.
path Parameters
accountNamestring · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
Request Body
namestring · pattern:^[a-z0-9-]{5,128}$· requiredA friendly name for the bucket.
descriptionstringA description of the bucket.
tagsobjectKey value pairs to associate with the bucket.
Responses
createdOnstring · date-time · readOnly · requiredWhen the item was created.
Example: 2023-04-18T05:54:34.408ZupdatedOnstring · date-time · readOnly · requiredWhen the item was last updated.
Example: 2023-04-20T05:54:34.408Zidstring · readOnly · requirednamestring · pattern:^[a-z0-9-]{5,128}$· requiredA friendly name for the bucket.
isRetrievablebooleanWhether the API keys stored in the bucket are retrievable
descriptionstringA description of the bucket.
tagsobjectKey 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
accountNamestring · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
Responses
createdOnstring · date-time · readOnly · requiredWhen the item was created.
Example: 2023-04-18T05:54:34.408ZupdatedOnstring · date-time · readOnly · requiredWhen the item was last updated.
Example: 2023-04-20T05:54:34.408Zidstring · readOnly · requirednamestring · pattern:^[a-z0-9-]{5,128}$· requiredA friendly name for the bucket.
isRetrievablebooleanWhether the API keys stored in the bucket are retrievable
descriptionstringA description of the bucket.
tagsobjectKey value pairs to associate with the bucket.
Deletes a bucket
Deletes a bucket and any related resources
path Parameters
accountNamestring · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
Responses
Updates a bucket
Updates a bucket, and returns the updated value.
path Parameters
accountNamestring · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · requiredThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
Request Body
descriptionstringA description of the bucket.
tagsobjectKey value pairs to associate with the bucket.
Responses
createdOnstring · date-time · readOnly · requiredWhen the item was created.
Example: 2023-04-18T05:54:34.408ZupdatedOnstring · date-time · readOnly · requiredWhen the item was last updated.
Example: 2023-04-20T05:54:34.408Zidstring · readOnly · requirednamestring · pattern:^[a-z0-9-]{5,128}$· requiredA friendly name for the bucket.
isRetrievablebooleanWhether the API keys stored in the bucket are retrievable
descriptionstringA description of the bucket.
tagsobjectKey value pairs to associate with the bucket.