This is the multi-page printable view of this section. Click here to print.
Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.
This guide provides a brief description of Secrets Manager and how to call CLI. The output is formatted as a JSON string
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Status | Not Before |
|---|---|---|
| 1.2 | CURRENT | - |
| 1.1 | SUPPORTED | 20270131 |
| 1.0 | DEPRECATED | 20260831 |
scp-cli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
[--acl_cidr <value>]
[--description <value>]
[--private_acl_enabled <value>]
[--private_acl_resources <value>]
[--tags <value>]
Create secret.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |
| name required | string | Secret Name | name |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr optional | string | Access control list of secret in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| description optional | string | Description of secret | description |
| private_acl_enabled optional | boolean | Enable private access control | true |
| private_acl_resources optional | array | Private access control resources | '{"resource_id": ""}' |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| private_acl_enabled | Enable private access control | true |
| private_acl_resources | Private access control resources | [{‘resource_id’: ‘vs-xxxxx’, ‘resource_name’: ‘my-server’, ‘resource_type’: ‘virtual_server’}] |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
[--acl_cidr <value>]
[--description <value>]
[--private_acl_enabled <value>]
[--private_acl_resources <value>]
[--tags <value>]
Create secret.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |
| name required | string | Secret Name | name |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr optional | string | Access control list of secret in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| description optional | string | Description of secret | description |
| private_acl_enabled optional | boolean | Enable private access control | true |
| private_acl_resources optional | array | Private access control resources | '{"resource_id": ""}' |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| private_acl_enabled | Enable private access control | true |
| private_acl_resources | Private access control resources | [{‘resource_id’: ‘vs-xxxxx’, ‘resource_name’: ‘my-server’, ‘resource_type’: ‘virtual_server’}] |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret create
--secret_value <value>
--name <value>
--kms_id <value>
[--acl_cidr <value>]
[--description <value>]
[--tags <value>]
Create secret.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |
| name required | string | Secret Name | name |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr optional | string | Access control list of secret in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
| description optional | string | Description of secret | description |
| tags optional | array | Tag List' | '{"key": "", "value": ""}' |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>
Delete secret.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| waiting_time_ndays required | integer | Days remaining until deletion | 7 |
scp-cli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>
Delete secret.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| waiting_time_ndays required | integer | Days remaining until deletion | 7 |
scp-cli secretsmanager secret delete
--secret_id <value>
--waiting_time_ndays <value>
Delete secret.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| waiting_time_ndays required | integer | Days remaining until deletion | 7 |
scp-cli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]
Generate random password.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| exclude_characters optional | string | Characters to exclude when generating password | abcdefg |
| exclude_lowercase optional | boolean | Option to exclude lowercase letters | false |
| exclude_numbers optional | boolean | Option to exclude numbers | false |
| exclude_punctuation optional | boolean | Option to exclude punctuation | false |
| exclude_uppercase optional | boolean | Option to exclude uppercase letters | false |
| include_space optional | boolean | Option to include spaces | false |
| password_length optional | integer | Length of the password to generate | 32 |
| require_each_included_type optional | boolean | Require all included character types | true |
| Name | Description | Example |
|---|---|---|
| random_password | Generate random password. | random-value |
scp-cli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]
Generate random password.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| exclude_characters optional | string | Characters to exclude when generating password | abcdefg |
| exclude_lowercase optional | boolean | Option to exclude lowercase letters | false |
| exclude_numbers optional | boolean | Option to exclude numbers | false |
| exclude_punctuation optional | boolean | Option to exclude punctuation | false |
| exclude_uppercase optional | boolean | Option to exclude uppercase letters | false |
| include_space optional | boolean | Option to include spaces | false |
| password_length optional | integer | Length of the password to generate | 32 |
| require_each_included_type optional | boolean | Require all included character types | true |
| Name | Description | Example |
|---|---|---|
| random_password | Generate random password. | random-value |
scp-cli secretsmanager generate random password
[--exclude_characters <value>]
[--exclude_lowercase <value>]
[--exclude_numbers <value>]
[--exclude_punctuation <value>]
[--exclude_uppercase <value>]
[--include_space <value>]
[--password_length <value>]
[--require_each_included_type <value>]
Generate random password.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| exclude_characters optional | string | Characters to exclude when generating password | abcdefg |
| exclude_lowercase optional | boolean | Option to exclude lowercase letters | false |
| exclude_numbers optional | boolean | Option to exclude numbers | false |
| exclude_punctuation optional | boolean | Option to exclude punctuation | false |
| exclude_uppercase optional | boolean | Option to exclude uppercase letters | false |
| include_space optional | boolean | Option to include spaces | false |
| password_length optional | integer | Length of the password to generate | 32 |
| require_each_included_type optional | boolean | Require all included character types | true |
| Name | Description | Example |
|---|---|---|
| random_password | Generate random password. | random-value |
scp-cli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
List secrets.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Secret Name | name |
| state optional | array | Secret State | A |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
List secrets.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Secret Name | name |
| state optional | array | Secret State | A |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--state <value>]
List secrets.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Secret Name | name |
| state optional | array | Secret State | A |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret list version
--secret_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
List versions of secrets.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| size optional | integer | size | 100 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| page | page | 0 |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| version_list |
scp-cli secretsmanager secret list version
--secret_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
List versions of secrets.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| size optional | integer | size | 100 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| Name | Description | Example |
|---|---|---|
| count | count | 20 |
| page | page | 0 |
| size | size | 20 |
| sort | sort | [‘created_at:asc’] |
| version_list |
scp-cli secretsmanager secret list version
--secret_id <value>
List versions of secrets.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| Name | Description | Example |
|---|---|---|
| version_list |
scp-cli secretsmanager secret restore
--secret_id <value>
Cancel process of deleting secret.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret restore
--secret_id <value>
Cancel process of deleting secret.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret restore
--secret_id <value>
Cancel process of deleting secret.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>
Edit the IP CIDR value for access control when retrieving the value of a Secret.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr required | string | Access control list of secret in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
scp-cli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>
Edit the IP CIDR value for access control when retrieving the value of a Secret.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr required | string | Access control list of secret in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
scp-cli secretsmanager secret set cidr
--secret_id <value>
--acl_cidr <value>
Edit the IP CIDR value for access control when retrieving the value of a Secret.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr required | string | Access control list of secret in CIDR | 192.168.1.1/24, 10.0.0.1/16 |
scp-cli secretsmanager secret set description
--secret_id <value>
--description <value>
Set description of secret.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| description required | string | Description of secret | description |
scp-cli secretsmanager secret set description
--secret_id <value>
--description <value>
Set description of secret.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| description required | string | Description of secret | description |
scp-cli secretsmanager secret set description
--secret_id <value>
--description <value>
Set description of secret.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| description required | string | Description of secret | description |
scp-cli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>
Modify the KMS ID used to encrypt the secret value.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>
Modify the KMS ID used to encrypt the secret value.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret set kmsid
--secret_id <value>
--kms_id <value>
Modify the KMS ID used to encrypt the secret value.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| kms_id required | string | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]
Labels are added, moved, or removed from a version. If only the move_to_version_id value is used, the label is added. If only the remove_from_version_id value is used, the label is removed. If both values are used, the label is moved from remove_from_version_id to move_to_version_id.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| label required | string | Label of secret version. Not allow duplication. | My Custom Label |
| move_to_version_id optional | string | Secret Version ID | 3265ab469f0d406d83073da3e11e7a6c |
| remove_from_version_id optional | string | Secret Version ID | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]
Labels are added, moved, or removed from a version. If only the move_to_version_id value is used, the label is added. If only the remove_from_version_id value is used, the label is removed. If both values are used, the label is moved from remove_from_version_id to move_to_version_id.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| label required | string | Label of secret version. Not allow duplication. | My Custom Label |
| move_to_version_id optional | string | Secret Version ID | 3265ab469f0d406d83073da3e11e7a6c |
| remove_from_version_id optional | string | Secret Version ID | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret update label
--secret_id <value>
--label <value>
[--move_to_version_id <value>]
[--remove_from_version_id <value>]
Labels are added, moved, or removed from a version. If only the move_to_version_id value is used, the label is added. If only the remove_from_version_id value is used, the label is removed. If both values are used, the label is moved from remove_from_version_id to move_to_version_id.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| label required | string | Label of secret version. Not allow duplication. | My Custom Label |
| move_to_version_id optional | string | Secret Version ID | 3265ab469f0d406d83073da3e11e7a6c |
| remove_from_version_id optional | string | Secret Version ID | 3265ab469f0d406d83073da3e11e7a6c |
scp-cli secretsmanager secret set private-acl
--secret_id <value>
[--private_acl_enabled <value>]
[--private_acl_resources <value>]
Update private acl.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| private_acl_enabled optional | boolean | Enable private access control | true |
| private_acl_resources optional | array | Private access control resources | '{"resource_id": ""}' |
scp-cli secretsmanager secret set private-acl
--secret_id <value>
[--private_acl_enabled <value>]
[--private_acl_resources <value>]
Update private acl.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| private_acl_enabled optional | boolean | Enable private access control | true |
| private_acl_resources optional | array | Private access control resources | '{"resource_id": ""}' |
scp-cli secretsmanager secret set private-acl
--secret_id <value>
[--private_acl_enabled <value>]
[--private_acl_resources <value>]
Update private acl.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| private_acl_enabled optional | boolean | Enable private access control | true |
| private_acl_resources optional | array | Private access control resources | '{"resource_id": ""}' |
scp-cli secretsmanager secret show
--secret_id <value>
Show secret detail.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| managed_type | scp or user | |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| offering | Name of offering | |
| private_acl_enabled | Enable private access control | true |
| private_acl_resources | Private access control resources | [{‘resource_id’: ‘vs-xxxxx’, ‘resource_name’: ‘my-server’, ‘resource_type’: ‘virtual_server’}] |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| region | Name of region | |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret show
--secret_id <value>
Show secret detail.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| offering | Name of offering | |
| private_acl_enabled | Enable private access control | true |
| private_acl_resources | Private access control resources | [{‘resource_id’: ‘vs-xxxxx’, ‘resource_name’: ‘my-server’, ‘resource_type’: ‘virtual_server’}] |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| region | Name of region | |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret show
--secret_id <value>
Show secret detail.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | 3265ab469f0d406d83073da3e11e7a6c |
| acl_cidr | Access control list of secret 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 |
| deleted_at | Date of deletion | 2025-02-25 03:07:17.000 |
| description | Description of secret | description |
| kms_id | Resource ID created in the Key Management Service (KMS) product | 3265ab469f0d406d83073da3e11e7a6c |
| kms_name | Resource name of KMS key | kmsname |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Name of key | my-secret-name |
| recent_searched_at | Date of recent search | 2025-02-25 03:07:17.000 |
| state | State of key(Creating, Active, Error, Stop, To_Be_Terminated) | Active |
| type | Type of secret | General |
scp-cli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]
Show secret value.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| label optional | string | Label of secret version. Not allow duplication. | CURRENT |
| version_id optional | string | Secret Version ID | e7b638507d9f4feeb6032a22b7640bf7 |
| Name | Description | Example |
|---|---|---|
| secret_value | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {“key1”:“value1”,“key2”:“value2”} |
scp-cli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]
Show secret value.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| label optional | string | Label of secret version. Not allow duplication. | CURRENT |
| version_id optional | string | Secret Version ID | e7b638507d9f4feeb6032a22b7640bf7 |
| Name | Description | Example |
|---|---|---|
| secret_value | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {“key1”:“value1”,“key2”:“value2”} |
scp-cli secretsmanager secret show value
--secret_id <value>
[--label <value>]
[--version_id <value>]
Show secret value.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| label optional | string | Label of secret version. Not allow duplication. | CURRENT |
| version_id optional | string | Secret Version ID | e7b638507d9f4feeb6032a22b7640bf7 |
| Name | Description | Example |
|---|---|---|
| secret_value | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {“key1”:“value1”,“key2”:“value2”} |
scp-cli secretsmanager secret update value
--secret_id <value>
--secret_value <value>
Update secret value.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |
scp-cli secretsmanager secret update value
--secret_id <value>
--secret_value <value>
Update secret value.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20270131 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |
scp-cli secretsmanager secret update value
--secret_id <value>
--secret_value <value>
Update secret value.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260831 |
| Name | Type | Description | Example |
|---|---|---|---|
| secret_id required | string | Secret ID | 3265ab469f0d406d83073da3e11e7a6c |
| secret_value required | string | The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs. | {"key1":"value1","key2":"value2"} |