Create secret
- Print
- PDF
Create secret
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Summary
Create a secret.
POST https://secretmanager.apigw.ntruss.com/api/v1/secrets
Request
Request body
{
"secretName": "string",
"memo": "string",
"secretValue": {
"value": "string",
"rotationTargets": [
"string"
]
},
"secretType": "BASIC",
"autoRotationYN": "N",
"autoRotationPeriod": 0,
"triggerId": "string",
"protectionKeyType": "DEFAULT",
"kmsKeyTag": "string"
}
| Parameter name | Type | Description |
|---|---|---|
| secretName | String | Secret name |
| memo | String | Notes |
| secretValue | Object | Secret value object |
| secretValue.value | String | Secret value |
| secretValue.rotationTargets | String[] | List of secret values to rotate |
| secretType | String | Secret type (e.g., BASIC) |
| autoRotationYN | String | Automatic rotation status (e.g., N) |
| autoRotationPeriod | Integer | Automatic rotation cycle |
| triggerId | String | Trigger ID |
| protectionKeyType | String | Protection key type (e.g., DEFAULT, USER_MANAGED_KEY) |
| kmsKeyTag | String | KMS key tag |
Response
Response body
{
"code": "SUCCESS",
"data": {
"secretId": "string",
"secretName": "string",
"secretStatus": "ENABLE",
"secretType": "string",
"memo": "string",
"region": "string",
"registerDate": 0,
"autoRotationYN": "Y",
"autoRotationPeriod": 0,
"nextRotationDate": 0,
"rotationPhase": "NONE",
"trigger": {
"id": "string",
"name": "string",
"url": "string",
"recentlyExecutedAction": "string"
},
"protectionKey": {
"type": "DEFAULT",
"kmsKeyTag": "string",
"kmsKeyName": "string"
}
}
}
| Parameter name | Type | Description |
|---|---|---|
| secretId | String | Secret ID |
| secretName | String | Secret name |
| secretStatus | String | Secret status (ENABLE, DISABLE, REVOKE, ROTATING, DESTROYED) |
| secretType | String | Secret type (BASIC) |
| memo | String | Notes |
| region | String | Region |
| registerDate | Integer | Registration date |
| autoRotationYN | String | Automatic rotation status |
| autoRotationPeriod | Integer | Automatic rotation cycle |
| nextRotationDate | Integer | Next rotation date |
| rotationPhase | String | Current rotation step (NONE) |
| trigger.id | String | Trigger ID |
| content.name | string | Trigger name |
| trigger.url | String | Trigger URL |
| trigger.recentlyExecutedAction | String | Recently executed action |
| protectionKey.type | String | Protection key type (DEFAULT, USER_MANAGED_KEY) |
| protectionKey.kmsKeyTag | String | KMS key tag |
| protectionKey.kmsKeyName | String | KMS key name |
Was this article helpful?