Create CVFS S3 Bucket of given properties

Select

SaaS

Customer Managed

Used to create CVFS S3 bucket and assigns READ-WRITE permission to the requesting user

application/json

Request Body

• name string

  The name of the CVFS S3 bucket to be created

• planName string

  Plan name to be used to fetch the CVFS S3 cluster

• versioning string

  Possible values: [UNVERSIONED, ENABLED, SUSPENDED]

  To enable/suspend the versioning on the CVFS S3 bucket

• bucketSize string

  Possible values: Value must match regular expression ^\d+\s(GB)$

  The size of the bucket in GB

Responses

• 200
• 400
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• id int32

  The ID of the created bucket

• endPointURL string

  The URL of bucket

{
  "id": 0,
  "endPointURL": "string"
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Internal Server Eror

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

POST /v4/cvfs/s3bucket    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

{
  "name": "string",
  "planName": "string",
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVFS/S3Bucket' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "planName": "string",
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVFS/S3Bucket' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "planName": "string",
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVFS/S3Bucket' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "planName": "string",
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVFS/S3Bucket' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "planName": "string",
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVFS/S3Bucket' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "planName": "string",
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVFS/S3Bucket' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "planName": "string",
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVFS/S3Bucket' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "planName": "string",
  "versioning": "UNVERSIONED",
  "bucketSize": "string"
}'