Create a new bucket
POST /accounts/{account_id}/topology/v1/buckets
Indicates the desired values for the Bucket API resource to be created.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
account_id |
string |
path |
True |
ID of the containing account resource
|
Request Body
Indicates the desired values for the Bucket API resource to be created.
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
name |
string |
False |
JSON string containing a user-assigned name for the bucket. Defined values are:
|
credentialID |
string |
True |
JSON string containing the identifier of the credentials used to access the bucket. Defined values are:
|
provider |
string |
True |
JSON string indicating the bucket protocol that can be used to access the bucket. Defined values are:
|
bucketParameters |
True |
JSON object that provides bucket provider-specific information required to access the bucket. The specific values in this bucket vary per provider. |
|
metadata |
False |
Client and service-specified metadata associated with the resource. Defined values are:
|
Example request
Response
Status: 201, Returns the newly created bucket resource in the JSON response body.
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
name |
string |
True |
JSON string containing a user-assigned name for the bucket. Defined values are:
|
credentialID |
string |
True |
JSON string containing the identifier of the credentials used to access the bucket. Defined values are:
|
state |
string |
True |
JSON string containing a value indicating the operational state of the bucket. Defined values are:
|
stateDetails |
array[type_astra_stateDetail] |
True |
JSON array of JSON objects that lists additional details about why "state" transitioned to "removed" or "failed". If no details are available, this array will be empty.
|
retentionTime |
number |
False |
Number of seconds representing the time a file on this bucket will be retained for. Defined values are:
|
provider |
string |
True |
JSON string indicating the bucket protocol that can be used to access the bucket. Defined values are:
|
bucketParameters |
True |
JSON object that provides bucket provider-specific information required to access the bucket. The specific values in this bucket vary per provider. |
|
metadata |
True |
Client and service-specified metadata associated with the resource. Defined values are:
|
Example response
Response
Status: 401, Unauthorized
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Response
Status: 400, Bad request
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
|
invalidFields |
array[invalidFields] |
False |
List of invalid request body fields |
Example response
Response
Status: 409, Conflict
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
|
invalidFields |
array[invalidFields] |
False |
List of invalid request body fields |
Example response
Response
Status: 403, Forbidden
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
Example response
Error
Status: 404, Not found
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
status |
string |
True |
|
correlationID |
string |
False |
Example error response
Definitions
See Definitions
s3
JSON object that provides Simple Storage Service (S3) protocol parameters. (Use this object for all S3 type providers).
Name | Type | Required | Description |
---|---|---|---|
serverURL |
string |
True |
JSON string containing a URL to the base path for the bucket. Defined values are:
|
bucketName |
string |
True |
JSON string containing the name of the S3 bucket. Defined values are:
|
gcp
JSON object that provides Google Cloud protocol parameters.
Name | Type | Required | Description |
---|---|---|---|
bucketName |
string |
True |
JSON string containing the name of the backing Google Cloud bucket name. Defined values are:
|
azure
JSON object that provides Azure protocol parameters.
Name | Type | Required | Description |
---|---|---|---|
storageAccount |
string |
True |
JSON string containing the Azure storage account name. Defined values are:
|
bucketName |
string |
True |
JSON string containing the name of the backing Azure blob name. Defined values are:
|
bucketParameters
JSON object that provides bucket provider-specific information required to access the bucket. The specific values in this bucket vary per provider.
Name | Type | Required | Description |
---|---|---|---|
s3 |
False |
JSON object that provides Simple Storage Service (S3) protocol parameters. (Use this object for all S3 type providers). |
|
gcp |
False |
JSON object that provides Google Cloud protocol parameters. |
|
azure |
False |
JSON object that provides Azure protocol parameters. |
type_astra_label
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_astra_metadata_update
Client and service-specified metadata associated with the resource. Defined values are:
-
Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.
Name | Type | Required | Description |
---|---|---|---|
labels |
array[type_astra_label] |
False |
|
creationTimestamp |
string |
False |
|
modificationTimestamp |
string |
False |
|
createdBy |
string |
False |
|
modifiedBy |
string |
False |
additionalDetails
type_astra_stateDetail
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
additionalDetails |
False |
invalidParams
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid query parameter |
reason |
string |
True |
Reason why the query parameter is invalid |
invalidFields
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid request body field |
reason |
string |
True |
Reason why the request body field is invalid |