This is the multi-page printable view of this section. Click here to print.
APIs
- 1: Create Secret Vault
- 1.1: 1.0
- 2: Delete Secret Vault
- 2.1: 1.0
- 3: Get Temporary Key
- 3.1: 1.0
- 4: List Secret Vaults
- 4.1: 1.0
- 5: Show Secret Vault
- 5.1: 1.0
1 - Create Secret Vault
1.1 - 1.0
post /v1/secretvault
Description
Create Secret Vault.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SecretVaultCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | SecretVaultCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/secretvault
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretvault 1.0"
Request body
{
"access_key_id": "b754b12b39da4ce29a40c5e324650bd0",
"acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
"description": "description",
"name": "name",
"tags": [],
"temporary_key_ttl_nhours": "3",
"vault_token_ttl_ndays": "720"
}
Example HTTP response
Response 201
{
"secret_vault": {
"access_key_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"access_key_type": "Temporary",
"account_id": "3265ab469f0d406d83073da3e11e7a6c",
"acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_at": "2025-02-25 03:07:17.000",
"description": "description",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vaultkey",
"temporary_key_ttl_nhours": "36",
"user_name": "username",
"vault_token_expired_at": "2025-02-25 03:07:17.000",
"vault_token_id": "aace85da-965e-d95a-b4ed-8d32b5d6079",
"vault_token_secret_value": "6171392c-5fd9-43db-9e15-e14af0068f96",
"vault_token_ttl_ndays": "10",
"vaultkey_state": "Active",
"vaultkey_type": "SCP Open API Key",
"waiting_time_ndays": "10"
}
}
2 - Delete Secret Vault
2.1 - 1.0
put /v1/secretvault/{secret_vault_id}/terminated
Description
Change Secret Vault state to ‘To be terminated’.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | secret_vault_id required | Secret Vault Id Example : 3265ab469f0d406d83073da3e11e7a6c | string | None |
| body | body required | SecretVaultTerminatedRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SecretVaultShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/secretvault/{secret_vault_id}/terminated
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretvault 1.0"
Request body
{
"waiting_time_ndays": 7
}
Example HTTP response
Response 200
{
"secret_vault": {
"access_key": [
"0e3*****************************"
],
"access_key_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"access_key_type": [
"Temporary",
"Permanent"
],
"account_id": "3265ab469f0d406d83073da3e11e7a6c",
"acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_at": "2025-02-25 03:07:17.000",
"description": "description",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": [
"vaultkey"
],
"temp_key_expired_at": "2025-02-25 03:07:17.000",
"temporary_key_ttl_nhours": [
"36"
],
"vault_token_expired_at": "2025-02-25 03:07:17.000",
"vault_token_id": "aace85da-965e-d95a-b4ed-8d32b5d6079",
"vault_token_secret_value": "6171392c-5fd9-43db-9e15-e14af0068f96",
"vault_token_ttl_ndays": [
"10"
],
"vaultkey_state": "Active",
"vaultkey_type": [
"SCP Open API Key"
],
"waiting_time_ndays": "10"
}
}
3 - Get Temporary Key
3.1 - 1.0
get /v1/temporarykey/{secret_vault_id}
Description
Get Temporary Key.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| header | Svaccesskey required | token id issued by Secret Vault Example : 5dbd99e4-aad4-e822-9ab3-89b10cf7c9ef | string | None |
| header | Svsignature required | It generates a string to sign from the request, encrypts it with the HmacSHA256 algorithm with the Access Secret Key(token secret issued by Secret Vault), and encodes it into Base64. Example : fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef= | string | None |
| header | Svtimestamp required | defines the elapsed time from 00:00:00 Agreement World Time (UTC) on January 1, 1970, in milliseconds. Example : 1605290625682 | string | None |
| header | Svclienttype required | Client Type Example : Openapi | string | None |
| path | secret_vault_id required | Secret Vault Id Example : 3265ab469f0d406d83073da3e11e7a6c | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SecretVaultTemporaryKeyResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/temporarykey/{secret_vault_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretvault 1.0"
Example HTTP response
Response 200
{
"access_key": "testname",
"expired_at": "2025-02-25 03:07:17.000",
"secret_key": "testname"
}
4 - List Secret Vaults
4.1 - 1.0
get /v1/secretvault
Description
List Secret Vaults.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SecretVaultKeyListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/secretvault
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretvault 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"secret_vaults": [
{
"access_key_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"access_key_type": "Temporary",
"account_id": "3265ab469f0d406d83073da3e11e7a6c",
"acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_at": "2025-02-25 03:07:17.000",
"description": "description",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "vaultkey",
"temporary_key_ttl_nhours": "36",
"user_name": "username",
"vault_token_expired_at": "2025-02-25 03:07:17.000",
"vault_token_id": "[AES] SZtB6RasvLypCv4soJlQO3ZmYpUPjFblz7pstjBeTQJXcz/d5KB9TUR3gMY08mga4fxWaF6IfUzTMBh6j/CAaw==",
"vault_token_secret_value": "[AES] 91/kdnK4NDfs2HGWgNH/EYNnqD7OcM1unXWs0ZAuaFttIqgP8xMUx0dOaRfD6kOD7uuujFxF2nzx35D9Gz9nwQ==",
"vault_token_ttl_ndays": "10",
"vaultkey_state": "Active",
"vaultkey_type": "SCP Open API Key",
"waiting_time_ndays": "10"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
5 - Show Secret Vault
5.1 - 1.0
get /v1/secretvault/{secret_vault_id}
Description
Show Secret Vault.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | secret_vault_id required | Secret Vault Id Example : 3265ab469f0d406d83073da3e11e7a6c | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SecretVaultShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/secretvault/{secret_vault_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretvault 1.0"
Example HTTP response
Response 200
{
"secret_vault": {
"access_key": [
"0e3*****************************"
],
"access_key_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
"access_key_type": [
"Temporary",
"Permanent"
],
"account_id": "3265ab469f0d406d83073da3e11e7a6c",
"acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delete_at": "2025-02-25 03:07:17.000",
"description": "description",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": [
"vaultkey"
],
"temp_key_expired_at": "2025-02-25 03:07:17.000",
"temporary_key_ttl_nhours": [
"36"
],
"vault_token_expired_at": "2025-02-25 03:07:17.000",
"vault_token_id": "aace85da-965e-d95a-b4ed-8d32b5d6079",
"vault_token_secret_value": "6171392c-5fd9-43db-9e15-e14af0068f96",
"vault_token_ttl_ndays": [
"10"
],
"vaultkey_state": "Active",
"vaultkey_type": [
"SCP Open API Key"
],
"waiting_time_ndays": "10"
}
}