Create instance of S3 Vault
Select
Create instance of the S3 Vault
- application/json
Request Body
bucket object required
Specify name for S3 Vault
clientName string requiredName of the CV S3 store
plan object required
planId int32 requiredplanName string requiredPlan name to be used
cvs3Endpoints Client entity[]
List of client to be configured as S3 endpoints
clientId int32 requiredClient ID
clientName stringClient Name
owners User entity[]
List of users to add S3 Plan role and associate with new S3 Vault
userId int32 requiredUser ID
__type__ int32 requiredmust be set to 13
userGroups Group entity[]
List of groups to add S3 Plan role and associate with new S3 Vault
userGroupId int32 requiredGroup ID
__type__ int32 requiredmust be set to 15
- rotateKeys boolean
Flag to rotate users keys
- 200
- 400
- 403
- 404
- 409
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
response object
entity Client entity
clientId int32Client ID
clientName stringClient Name
errorCode int32errorMessage stringResponse message
warningCode int32warningMessage stringResponse message
addEndpointJob
jobId int64Job number to install S3 endpoint package on selected clients
response object
errorMessage stringTells about the error occured
errorCode ErrorCodePossible 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
{
"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"
}