Create instance of S3 Vault
Select
Create instance of the S3 Vault
- application/json
Request Body
bucket object required
plan object required
cvs3Endpoints Client entity[]
owners User entity[]
userGroups Group entity[]
- rotateKeys boolean
Flag to rotate users keys
- 200
- 400
- 403
- 404
- 409
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
response object
addEndpointJob
{
"response": {
"entity": {
"clientId": 0,
"clientName": "string"
},
"errorCode": 0,
"errorMessage": "string",
"warningCode": 0,
"warningMessage": "string"
},
"addEndpointJob": {
"jobId": 0,
"response": {
"errorMessage": "string",
"errorCode": "NO_ERROR"
}
}
}
Bad or incomplete request
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Requested Details not found
- 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"
}
Entiry with same name already exists
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Internal Processing Error
- 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/cvs3store
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVS3Store' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"bucket": {
"clientName": "string"
},
"plan": {
"planId": 0,
"planName": "string"
},
"cvs3Endpoints": [
{
"clientId": 0,
"clientName": "string"
}
],
"owners": [
{
"userId": 0,
"__type__": 0
}
],
"userGroups": [
{
"userGroupId": 0,
"__type__": 0
}
],
"rotateKeys": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVS3Store' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"bucket": {
"clientName": "string"
},
"plan": {
"planId": 0,
"planName": "string"
},
"cvs3Endpoints": [
{
"clientId": 0,
"clientName": "string"
}
],
"owners": [
{
"userId": 0,
"__type__": 0
}
],
"userGroups": [
{
"userGroupId": 0,
"__type__": 0
}
],
"rotateKeys": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVS3Store' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"bucket": {
"clientName": "string"
},
"plan": {
"planId": 0,
"planName": "string"
},
"cvs3Endpoints": [
{
"clientId": 0,
"clientName": "string"
}
],
"owners": [
{
"userId": 0,
"__type__": 0
}
],
"userGroups": [
{
"userGroupId": 0,
"__type__": 0
}
],
"rotateKeys": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVS3Store' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"bucket": {
"clientName": "string"
},
"plan": {
"planId": 0,
"planName": "string"
},
"cvs3Endpoints": [
{
"clientId": 0,
"clientName": "string"
}
],
"owners": [
{
"userId": 0,
"__type__": 0
}
],
"userGroups": [
{
"userGroupId": 0,
"__type__": 0
}
],
"rotateKeys": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVS3Store' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"bucket": {
"clientName": "string"
},
"plan": {
"planId": 0,
"planName": "string"
},
"cvs3Endpoints": [
{
"clientId": 0,
"clientName": "string"
}
],
"owners": [
{
"userId": 0,
"__type__": 0
}
],
"userGroups": [
{
"userGroupId": 0,
"__type__": 0
}
],
"rotateKeys": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVS3Store' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"bucket": {
"clientName": "string"
},
"plan": {
"planId": 0,
"planName": "string"
},
"cvs3Endpoints": [
{
"clientId": 0,
"clientName": "string"
}
],
"owners": [
{
"userId": 0,
"__type__": 0
}
],
"userGroups": [
{
"userGroupId": 0,
"__type__": 0
}
],
"rotateKeys": true
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/CVS3Store' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"bucket": {
"clientName": "string"
},
"plan": {
"planId": 0,
"planName": "string"
},
"cvs3Endpoints": [
{
"clientId": 0,
"clientName": "string"
}
],
"owners": [
{
"userId": 0,
"__type__": 0
}
],
"userGroups": [
{
"userGroupId": 0,
"__type__": 0
}
],
"rotateKeys": true
}'