Vault Management
Vault management includes the ability to Create, Read, Update and Delete vaults. Once a vault is created, API keys and IP whitelists can be managed on each vault independently.
Actions
Action | HTTP Method | Route | Description |
---|---|---|---|
Create Vault | POST | /api/api/vault/ | Vault creation is limited based on the type of vaults created. Vault type configurations are managed by the TokenEx support team. - Vaulted Vaults can create up to 100 new vaults per rolling 30 day calendar - Vaultless Vaults can create up to 500 new vaults per rolling 30 day calendarUpon successful creation we will return your new TokenEx ID. |
Get Vaults | GET | /api/api/vault/ | Request list of active TokenEx IDs. Response also includes number of vaults remaining in current rolling 30 day period. |
Get Vault Details | GET | /api/api/vault/{TokenEx ID} | Retrieve specific vault details including IP Whitelists, number of API keys and permissions |
Update Vault | PUT | /api/api/vault/{TokenEx ID} | Update the Vault Name |
Delete Vault | DELETE | /api/api/vault/{TokenEx ID} | Removes the TokenEx ID from your list of active TokenEx IDs. All new vault activity will error. |
Examples
Create Vault
- Request
- Response
POST /api/api/vault/ HTTP/1.1
Host: test-my.tokenex.com
Content-Type: application/json
Authorization: {Your Authorization Value}
{
"Name": "string"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"Vault": {
"TokenExId": "string",
"Name": "string",
"Add_Date": "string"
},
"ApiKeys": ["string"],
"Summary": {
"TotalVaults": number,
"VaultsCreatedInLastThirtyDays": number
}
}
Get Vaults
- Request
- Response
GET /api/api/vault HTTP/1.1
Host: test-my.tokenex.com
Authorization: {Your Authorization Value}
HTTP/1.1 200 OK
Content-Type: application/json
{
"Vaults": [
{
"TokenExId": "string",
"Name": "string",
"Add_Date": "string"
}
],
"Summary": {
"TotalVaults": number,
"VaultsCreatedInLastThirtyDays": number
}
}
Get Vault Details
- Request
- Response
GET /api/api/vault/12345 HTTP/1.1
Host: test-my.tokenex.com
Authorization: {Your Authorization Value}
HTTP/1.1 200 OK
Content-Type: application/json
{
"Vault": {
"TokenExId": "string",
"Name": "string",
"Add_Date": "string"
},
"ApiKeys": ["string"],
"Summary": {
"TotalVaults": number,
"VaultsCreatedInLastThirtyDays": number
}
}
Update Vault
- Request
- Response
PUT /api/api/vault/12345
Host: test-my.tokenex.com
Content-Type: application/json
Authorization: {Your Authorization Value}
{
"name": "string"
}
HTTP/1.1 200 OK
Delete Vault
- Request
- Response
DELETE /api/api/vault/12345 HTTP/1.1
Host: test-my.tokenex.com
Authorization: {Your Authorization Value}
HTTP/1.1 200 OK