This is the multi-page printable view of this section. Click here to print.
CLIs
- 1: Create Secret Vault
- 1.1: 1.0
- 2: Delete Secret Vault
- 2.1: 1.0
- 3: List Secret Vaults
- 3.1: 1.0
- 4: Show Secret Vault
- 4.1: 1.0
1 - Create Secret Vault
1.1 - 1.0
scpcli secretvault sv create
--vault_token_ttl_ndays <value>
--temporary_key_ttl_nhours <value>
--name <value>
--acl_cidr <value>
--access_key_id <value>
[--description <value>]
[--tags <value>]
Description
Create Secret Vault.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| vault_token_ttl_ndays required | integer | TTL of vault token | 720 |
| temporary_key_ttl_nhours required | integer | Temporary key valid hours | 3 |
| name required | string | Secret Vault Id | name |
| acl_cidr required | string | Access control list in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| access_key_id required | string | Id of access key | b754b12b39da4ce29a40c5e324650bd0 |
| description optional | string | Description | description |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| access_key_id | Id of access key | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| access_key_type | Type of access key | Temporary |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description | description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | vaultkey |
| temporary_key_ttl_nhours | Temporary key valid hours | 36 |
| user_name | User name | username |
| vault_token_expired_at | Vault Token expired date | 2025-02-25 03:07:17.000 |
| vault_token_id | Id of vault token | aace85da-965e-d95a-b4ed-8d32b5d6079 |
| vault_token_secret_value | Secret of vault token | 6171392c-5fd9-43db-9e15-e14af0068f96 |
| vault_token_ttl_ndays | TTL of vault token | 10 |
| vaultkey_state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| vaultkey_type | Type of vault key | SCP Open API Key |
| waiting_time_ndays | Days remaining until deletion | 10 |
2 - Delete Secret Vault
2.1 - 1.0
scpcli secretvault sv delete
--secret_vault_id <value>
--waiting_time_ndays <value>
Description
Change Secret Vault state to ‘To be terminated’.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_vault_id required | string | Secret Vault Id | 3265ab469f0d406d83073da3e11e7a6c |
| waiting_time_ndays required | integer | Days remaining until deletion | 7 |
3 - List Secret Vaults
3.1 - 1.0
scpcli secretvault sv list
Description
List Secret Vaults.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| access_key_id | Id of access key | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| access_key_type | Type of access key | Temporary |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description | description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | vaultkey |
| temporary_key_ttl_nhours | Temporary key valid hours | 36 |
| user_name | User name | username |
| vault_token_expired_at | Vault Token expired date | 2025-02-25 03:07:17.000 |
| vault_token_id | Id of vault token | [AES] SZtB6RasvLypCv4soJlQO3ZmYpUPjFblz7pstjBeTQJXcz/d5KB9TUR3gMY08mga4fxWaF6IfUzTMBh6j/CAaw== |
| vault_token_secret_value | Secret of vault token | [AES] 91/kdnK4NDfs2HGWgNH/EYNnqD7OcM1unXWs0ZAuaFttIqgP8xMUx0dOaRfD6kOD7uuujFxF2nzx35D9Gz9nwQ== |
| vault_token_ttl_ndays | TTL of vault token | 10 |
| vaultkey_state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| vaultkey_type | Type of vault key | SCP Open API Key |
| waiting_time_ndays | Days remaining until deletion | 10 |
4 - Show Secret Vault
4.1 - 1.0
scpcli secretvault sv show
--secret_vault_id <value>
Description
Show Secret Vault.
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| secret_vault_id required | string | Secret Vault Id | 3265ab469f0d406d83073da3e11e7a6c |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| access_key | Access key | [‘0e3*****************************’] |
| access_key_id | Id of access key | 0e3dffc50eb247a1adf4f2e5c82c4f99 |
| access_key_type | Type of access key | [‘Temporary’, ‘Permanent’] |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| delete_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of Key | description |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | [‘vaultkey’] |
| temp_key_expired_at | Temporary key expired date | 2025-02-25 03:07:17.000 |
| temporary_key_ttl_nhours | Temporary key valid hours | [‘36’] |
| vault_token_expired_at | Vault Token expired date | 2025-02-25 03:07:17.000 |
| vault_token_id | Id of vault token | aace85da-965e-d95a-b4ed-8d32b5d6079 |
| vault_token_secret_value | Secret of vault token | 6171392c-5fd9-43db-9e15-e14af0068f96 |
| vault_token_ttl_ndays | TTL of vault token | [‘10’] |
| vaultkey_state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| vaultkey_type | Type of vault key | [‘SCP Open API Key’] |
| waiting_time_ndays | Days remaining until deletion | 10 |