API Keys - Buckets
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.
https://dev.zuplo.com
Lists buckets
Creates a bucket
Creates a new bucket for this account.
path Parameters
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
Request Body
name
string · pattern:^[a-z0-9-]{5,128}$
· requiredA friendly name for the bucket.
description
stringA description of the bucket.
tags
objectKey value pairs to associate with the bucket.
Responses
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredname
string · pattern:^[a-z0-9-]{5,128}$
· requiredA friendly name for the bucket.
isRetrievable
booleanWhether the API keys stored in the bucket are retrievable
description
stringA description of the bucket.
tags
objectKey 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
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · 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
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredname
string · pattern:^[a-z0-9-]{5,128}$
· requiredA friendly name for the bucket.
isRetrievable
booleanWhether the API keys stored in the bucket are retrievable
description
stringA description of the bucket.
tags
objectKey value pairs to associate with the bucket.
Deletes a bucket
Deletes a bucket and any related resources
path Parameters
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · 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
accountName
string · requiredThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketName
string · 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
description
stringA description of the bucket.
tags
objectKey value pairs to associate with the bucket.
Responses
createdOn
string · date-time · readOnly · requiredWhen the item was created.
updatedOn
string · date-time · readOnly · requiredWhen the item was last updated.
id
string · readOnly · requiredname
string · pattern:^[a-z0-9-]{5,128}$
· requiredA friendly name for the bucket.
isRetrievable
booleanWhether the API keys stored in the bucket are retrievable
description
stringA description of the bucket.
tags
objectKey value pairs to associate with the bucket.