Create Vault

1min
POST
This endpoint create and configure a new data Vault. Vaults are created to store the data of a particular category like phone numbers. Vault name is unique per Tenant and can't be updated once created.
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-SDS-SIGNATURE
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
X-COREOS-TID
string
*
Body Parameters
body
VaultCreateRequest
Description
Request object with name of the vault to be reqistered and its configurations such as list of apps with permissions, read limit, and owner.
name
string
*
owner
string
*
readLimit
integer<int64>
uniqueData
boolean
permissions
AppPermission[]
enable
boolean
Responses
200
OK - The request succeeded.
SuccessResponse
All Of
object  +
data
object
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
request
Request
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
request
Request
403
Forbidden - The client's identity is known to the server but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
request
Request
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubdomain}/core/api/v1/sds/vaults' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "owner": "",
  "permissions": [
    {
      "app": "",
      "permission": ""
    }
  ]
}'
curl --location --globoff 'https://{tenantSubdomain}/core/api/v1/sds/vaults' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "name": "",
  "owner": "",
  "permissions": [
    {
      "app": "",
      "permission": ""
    }
  ]
}'
Responses
200
400
401
403
503
// OK - The request succeeded. 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
// OK - The request succeeded. 
{
  "data": {
    "id": ""
  },
  "request": {
    "uri": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
﻿
﻿
Updated 21 Sep 2023
Did this page help you?
Update App Public Key
Get Vault