Skip to main content

Create instance of S3 Vault

Select

SaaS
Customer Managed

Create instance of the S3 Vault

Request Body
  • bucket object required

    Specify name for S3 Vault

  • clientName string required

    Name of the CV S3 store

  • plan object required
  • planId int32 required
  • planName string required

    Plan name to be used

  • cvs3Endpoints Client entity[]

    List of client to be configured as S3 endpoints

  • clientId int32 required

    Client ID

  • clientName string

    Client Name

  • owners User entity[]

    List of users to add S3 Plan role and associate with new S3 Vault

  • userId int32 required

    User ID

  • __type__ int32 required

    must be set to 13

  • userGroups Group entity[]

    List of groups to add S3 Plan role and associate with new S3 Vault

  • userGroupId int32 required

    Group ID

  • __type__ int32 required

    must be set to 15

  • rotateKeys boolean

    Flag to rotate users keys

Responses

Success


Schema
  • response object
  • entity Client entity
  • clientId int32

    Client ID

  • clientName string

    Client Name

  • errorCode int32
  • errorMessage string

    Response message

  • warningCode int32
  • warningMessage string

    Response message

  • addEndpointJob
  • jobId int64

    Job number to install S3 endpoint package on selected clients

  • response object
  • 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

POST /v4/cvs3store    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{
"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
}'