이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.

Secrets Manager

1: APIs

1.1: Create Secret

1.1.1: 1.1
1.1.2: 1.0

1.2: Delete Secret

1.2.1: 1.1
1.2.2: 1.0

1.3: Generate Random Password

1.3.1: 1.1
1.3.2: 1.0

1.4: List Secrets

1.4.1: 1.1
1.4.2: 1.0

1.5: List Versions of Secret

1.5.1: 1.1
1.5.2: 1.0

1.6: Restore Secret

1.6.1: 1.1
1.6.2: 1.0

1.7: Set CIDR of Secret

1.7.1: 1.1
1.7.2: 1.0

1.8: Set Description of Secret

1.8.1: 1.1
1.8.2: 1.0

1.9: Set KMS ID of Secret

1.9.1: 1.1
1.9.2: 1.0

1.10: Set Label of Version

1.10.1: 1.1
1.10.2: 1.0

1.11: Set Private Acl of Secret

1.11.1: 1.1
1.11.2: 1.0

1.12: Show Secret Detail

1.12.1: 1.1
1.12.2: 1.0

1.13: Show Secret Value

1.13.1: 1.1
1.13.2: 1.0

1.14: Update Secret Value

1.14.1: 1.1
1.14.2: 1.0

2: Models

2.1: PrivateAclResource
2.2: PrivateAclResourceId
2.3: SecretsManager
2.4: SecretsManagerCreateRequest
2.5: SecretsManagerCreateRequestV1Dot1
2.6: SecretsManagerCreateResponse
2.7: SecretsManagerCreateResponseV1Dot1
2.8: SecretsManagerIncludePrivateAcl
2.9: SecretsManagerIncludePrivateAclAndSrn
2.10: SecretsManagerListResponse
2.11: SecretsManagerSetCidrRequest
2.12: SecretsManagerSetDescriptionRequest
2.13: SecretsManagerSetKmsRequest
2.14: SecretsManagerSetPrivateAclRequest
2.15: SecretsManagerSetSecretValueRequest
2.16: SecretsManagerShowResponse
2.17: SecretsManagerShowResponseV1Dot1
2.18: SecretsManagerShowSecretValueRequest
2.19: SecretsManagerShowSecretValueResponse
2.20: SecretsManagerTerminatedRequest
2.21: SecretsManagerUpdatedPrivateAclResponse
2.22: SecretsManagerUpdateLabelRequest
2.23: SecretsManagerVersionListResponse
2.24: SecretsManagerVersionListResponseV1Dot1
2.25: SecretsRandomPasswordRequest
2.26: SecretsRandomPasswordResponse
2.27: Tag

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 Secrets Manager에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Version	Status	Not Before
1.1	CURRENT	-
1.0	SUPPORTED	20260831

OpenAPI URL

https://secretsmanager.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environment	region
s	kr-west1
s	kr-east1
g	kr-south1
g	kr-south2
g	kr-south3
e	kr-west1
e	kr-east1

1 - APIs

1.1 - Create Secret

1.1.1 - 1.1

post /v1/secrets

Description

Secret 을 생성합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecretsManagerCreateRequestV1Dot1

Responses

HTTP Code	Description	Schema
201	Created	SecretsManagerCreateResponseV1Dot1
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
    "description": "description",
    "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
    "name": "name",
    "private_acl_enabled": "true",
    "private_acl_resources": [],
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
    "tags": []
}

Example HTTP response

Response 201

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "private_acl_enabled": "true",
        "private_acl_resources": [],
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.1.2 - 1.0

post /v1/secrets

Description

Secret 을 생성합니다.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		SecretsManagerCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	SecretsManagerCreateResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
    "description": "description",
    "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
    "name": "name",
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
    "tags": []
}

Example HTTP response

Response 201

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.2 - Delete Secret

1.2.1 - 1.1

delete /v1/secrets/{secret_id}

Description

Secret을 삭제한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerTerminatedRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "waiting_time_ndays": 7
}

Example HTTP response

Response 204

1.2.2 - 1.0

delete /v1/secrets/{secret_id}

Description

Secret을 삭제한다.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerTerminatedRequest

Responses

HTTP Code	Description	Schema
204	No Content	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "waiting_time_ndays": 7
}

Example HTTP response

Response 204

1.3 - Generate Random Password

1.3.1 - 1.1

post /v1/secrets/random-password

Description

임의 비밀번호 생성

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		SecretsRandomPasswordRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsRandomPasswordResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets/random-password

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "exclude_characters": "abcdefg",
    "exclude_lowercase": "false",
    "exclude_numbers": "false",
    "exclude_punctuation": "false",
    "exclude_uppercase": "false",
    "include_space": "false",
    "password_length": 32,
    "require_each_included_type": "true"
}

Example HTTP response

Response 200

{
    "random_password": "random-value"
}

1.3.2 - 1.0

post /v1/secrets/random-password

Description

임의 비밀번호 생성

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		SecretsRandomPasswordRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsRandomPasswordResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets/random-password

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "exclude_characters": "abcdefg",
    "exclude_lowercase": "false",
    "exclude_numbers": "false",
    "exclude_punctuation": "false",
    "exclude_uppercase": "false",
    "include_space": "false",
    "password_length": 32,
    "require_each_included_type": "true"
}

Example HTTP response

Response 200

{
    "random_password": "random-value"
}

1.4 - List Secrets

1.4.1 - 1.1

get /v1/secrets

Description

Secret 목록을 조회한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Secret 이름 Example : `name`	any of [string, null]	None
query	state optional	Secret 상태 Example : `Active`	any of [array[string], null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secret": [
        {
            "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",
            "deleted_at": "2025-02-25 03:07:17.000",
            "description": "description",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
            "kms_name": "kmsname",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "my-secret-name",
            "recent_searched_at": "2025-02-25 03:07:17.000",
            "state": "Active",
            "type": "General"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.4.2 - 1.0

get /v1/secrets

Description

Secret 목록을 조회한다.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Secret 이름 Example : `name`	any of [string, null]	None
query	state optional	Secret 상태 Example : `Active`	any of [array[string], null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerListResponse
400	Bad Request	None
403	Forbidden	None

Example HTTP request

Request path

/v1/secrets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secret": [
        {
            "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",
            "deleted_at": "2025-02-25 03:07:17.000",
            "description": "description",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
            "kms_name": "kmsname",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "my-secret-name",
            "recent_searched_at": "2025-02-25 03:07:17.000",
            "state": "Active",
            "type": "General"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.5 - List Versions of Secret

1.5.1 - 1.1

get /v1/secrets/{secret_id}/versions

Description

Secrets 버전 리스트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
query	size optional	size Example : `100`	any of [integer, null]	100
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerVersionListResponseV1Dot1
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ],
    "version_list": [
        ""
    ]
}

1.5.2 - 1.0

get /v1/secrets/{secret_id}/versions

Description

Secrets 버전 리스트

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerVersionListResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "version_list": [
        ""
    ]
}

1.6 - Restore Secret

1.6.1 - 1.1

put /v1/secrets/{secret_id}/restore

Description

Secret 삭제 절차를 취소한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.6.2 - 1.0

put /v1/secrets/{secret_id}/restore

Description

Secret 삭제 절차를 취소한다.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.7 - Set CIDR of Secret

1.7.1 - 1.1

put /v1/secrets/{secret_id}/acl-cidr

Description

Secret의 Value 조회 접근제어를 위한 IP CIDR 값을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetCidrRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/acl-cidr

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16"
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.7.2 - 1.0

put /v1/secrets/{secret_id}/acl-cidr

Description

Secret의 Value 조회 접근제어를 위한 IP CIDR 값을 수정한다.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetCidrRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/acl-cidr

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16"
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.8 - Set Description of Secret

1.8.1 - 1.1

put /v1/secrets/{secret_id}/description

Description

Secret의 설명값을 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.8.2 - 1.0

put /v1/secrets/{secret_id}/description

Description

Secret의 설명값을 수정한다.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetDescriptionRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.9 - Set KMS ID of Secret

1.9.1 - 1.1

put /v1/secrets/{secret_id}/kmsid

Description

Secret Value 암호화에 사용한 KMS ID 를 수정한다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetKmsRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/kmsid

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "kms_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.9.2 - 1.0

put /v1/secrets/{secret_id}/kmsid

Description

Secret Value 암호화에 사용한 KMS ID 를 수정한다.

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetKmsRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/kmsid

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "kms_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.10 - Set Label of Version

1.10.1 - 1.1

put /v1/secrets/{secret_id}/label

Description

Version 에 라벨을 추가/이동/삭제합니다. move_to_version_id 값만 사용하는 경우 라벨이 추가되고, remove_from_version_id 값만 사용하는경우 라벨이 제거됩니다. 둘다 사용하는경우, remove_from_version_id 의 라벨값이 move_to_version_id로 이동합니다.

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerUpdateLabelRequest

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/label

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "label": "My Custom Label",
    "move_to_version_id": "3265ab469f0d406d83073da3e11e7a6c",
    "remove_from_version_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 200

1.10.2 - 1.0

put /v1/secrets/{secret_id}/label

Description

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerUpdateLabelRequest

Responses

HTTP Code	Description	Schema
200	OK	None
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/label

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "label": "My Custom Label",
    "move_to_version_id": "3265ab469f0d406d83073da3e11e7a6c",
    "remove_from_version_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 200

1.11 - Set Private Acl of Secret

1.11.1 - 1.1

put /v1/secrets/{secret_id}/private-acl

Description

Private acl 업데이트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetPrivateAclRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerUpdatedPrivateAclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/private-acl

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "private_acl_enabled": "true",
    "private_acl_resources": []
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "private_acl_enabled": "true",
        "private_acl_resources": [],
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.11.2 - 1.0

put /v1/secrets/{secret_id}/private-acl

Description

Private acl 업데이트

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetPrivateAclRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerUpdatedPrivateAclResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/private-acl

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "private_acl_enabled": "true",
    "private_acl_resources": []
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "private_acl_enabled": "true",
        "private_acl_resources": [],
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.12 - Show Secret Detail

1.12.1 - 1.1

get /v1/secrets/{secret_id}

Description

Secret 상세정보 보기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponseV1Dot1
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "offering": "",
        "private_acl_enabled": "true",
        "private_acl_resources": [],
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "region": "",
        "state": "Active",
        "type": "General"
    }
}

1.12.2 - 1.0

get /v1/secrets/{secret_id}

Description

Secret 상세정보 보기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.13 - Show Secret Value

1.13.1 - 1.1

post /v1/secrets/{secret_id}/values

Description

Secret value 보기

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerShowSecretValueRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowSecretValueResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/values

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "label": "CURRENT",
    "version_id": "e7b638507d9f4feeb6032a22b7640bf7"
}

Example HTTP response

Response 200

{
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}

1.13.2 - 1.0

post /v1/secrets/{secret_id}/values

Description

Secret value 보기

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerShowSecretValueRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowSecretValueResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/values

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "label": "CURRENT",
    "version_id": "e7b638507d9f4feeb6032a22b7640bf7"
}

Example HTTP response

Response 200

{
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}

1.14 - Update Secret Value

1.14.1 - 1.1

put /v1/secrets/{secret_id}/values

Description

Secret value 업데이트

상태 ACTIVE (CURRENT)

버전	최소 지원 보장일
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetSecretValueRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/values

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.1"

Request body

{
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.14.2 - 1.0

put /v1/secrets/{secret_id}/values

Description

Secret value 업데이트

상태 ACTIVE (SUPPORTED)

버전	최소 지원 보장일
1.0	20260831

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	string	None
body	body required		SecretsManagerSetSecretValueRequest

Responses

HTTP Code	Description	Schema
200	OK	SecretsManagerShowResponse
400	Bad Request	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/secrets/{secret_id}/values

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}

Example HTTP response

Response 200

{
    "secret": {
        "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",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

2 - Models

2.1 - PrivateAclResource

Name	Description	Schema
resource_id optional	자원 식별자 Example :	string
resource_name optional	자원 명 Example :	string
resource_type optional	자원 유형 Example :	string

2.2 - PrivateAclResourceId

Name	Description	Schema	Default
resource_id optional	자원 식별자 Example :	string

2.3 - SecretsManager

Name	Description	Schema
account_id required	계정 id Example : `3265ab469f0d406d83073da3e11e7a6c`	string
acl_cidr required	Secret 접근허용 CIDR 리스트 Example : `192.168.1.1/24, 10.0.0.1/16`	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
deleted_at required	삭제 날짜 Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
description required	Secret 설명 Example : `description`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
kms_id required	Key Management Service 상품에서 생성한 자원 ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
kms_name required	KMS 키 이름 Example : `kmsname`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	키 이름 Example : `my-secret-name`	any of [string, null]
recent_searched_at required	최근 검색일 Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
state required	키 상태(Creating, Active, Error, Stop, To_Be_Terminated) Example : `Active`	any of [string, null]
type required	Secret 타입 Example : `General`	any of [string, null]

2.4 - SecretsManagerCreateRequest

Name	Description	Schema
acl_cidr required	Secret 접근허용 CIDR 리스트 Example : `192.168.1.1/24, 10.0.0.1/16`	string
description optional	Secret 설명 Example : `description`	any of [string, null]
kms_id required	Key Management Service 상품에서 생성한 자원 ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
name required	Secret 이름 Example : `name` Pattern : `^[A-Za-z0-9_-]$` Minimum length* : `3` Maximum length : `63`	string
secret_value required	Secret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다. Example : `{"key1":"value1","key2":"value2"}`	string
tags optional	태그 리스트	any of [array[Tag], null]

2.5 - SecretsManagerCreateRequestV1Dot1

Name	Description	Schema
acl_cidr required	Secret 접근허용 CIDR 리스트 Example : `192.168.1.1/24, 10.0.0.1/16`	string
description optional	Secret 설명 Example : `description`	any of [string, null]
kms_id required	Key Management Service 상품에서 생성한 자원 ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
name required	Secret 이름 Example : `name` Pattern : `^[A-Za-z0-9_-]$` Minimum length* : `3` Maximum length : `63`	string
private_acl_enabled optional	프라이빗 접근 제어 활성화 Example : `true`	boolean
private_acl_resources optional	프라이빗 접근 제어 자원들	any of [array[PrivateAclResourceId], null]
secret_value required	Secret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다. Example : `{"key1":"value1","key2":"value2"}`	string
tags optional	태그 리스트	any of [array[Tag], null]

2.6 - SecretsManagerCreateResponse

Name	Description	Schema	Default
secret required		SecretsManager

2.7 - SecretsManagerCreateResponseV1Dot1

Name	Description	Schema	Default
secret required		SecretsManagerIncludePrivateAcl

2.8 - SecretsManagerIncludePrivateAcl

Name	Description	Schema
account_id required	계정 id Example : `3265ab469f0d406d83073da3e11e7a6c`	string
acl_cidr required	Secret 접근허용 CIDR 리스트 Example : `192.168.1.1/24, 10.0.0.1/16`	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
deleted_at required	삭제 날짜 Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
description required	Secret 설명 Example : `description`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
kms_id required	Key Management Service 상품에서 생성한 자원 ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
kms_name required	KMS 키 이름 Example : `kmsname`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	키 이름 Example : `my-secret-name`	any of [string, null]
private_acl_enabled optional	프라이빗 접근 제어 활성화 Example : `true`	boolean
private_acl_resources optional	프라이빗 접근 제어 자원들	any of [array[PrivateAclResource], null]
recent_searched_at required	최근 검색일 Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
state required	키 상태(Creating, Active, Error, Stop, To_Be_Terminated) Example : `Active`	any of [string, null]
type required	Secret 타입 Example : `General`	any of [string, null]

2.9 - SecretsManagerIncludePrivateAclAndSrn

Name	Description	Schema
account_id required	계정 id Example : `3265ab469f0d406d83073da3e11e7a6c`	string
acl_cidr required	Secret 접근허용 CIDR 리스트 Example : `192.168.1.1/24, 10.0.0.1/16`	any of [string, null]
created_at required	생성 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
created_by required	생성자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
deleted_at required	삭제 날짜 Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
description required	Secret 설명 Example : `description`	any of [string, null]
id required	ID Example : `0fdd87aab8cb46f59b7c1f81ed03fb3e`	string
kms_id required	Key Management Service 상품에서 생성한 자원 ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
kms_name required	KMS 키 이름 Example : `kmsname`	string
modified_at required	수정 시간 Example : `2024-05-17T00:23:17Z`	string (date-time)
modified_by required	수정자 Example : `90dddfc2b1e04edba54ba2b41539a9ac`	string
name required	키 이름 Example : `my-secret-name`	any of [string, null]
offering required	오퍼링 이름 Example :	string
private_acl_enabled optional	프라이빗 접근 제어 활성화 Example : `true`	boolean
private_acl_resources optional	프라이빗 접근 제어 자원들	any of [array[PrivateAclResource], null]
recent_searched_at required	최근 검색일 Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
region required	리즌 이름 Example :	string
state required	키 상태(Creating, Active, Error, Stop, To_Be_Terminated) Example : `Active`	any of [string, null]
type required	Secret 타입 Example : `General`	any of [string, null]

2.10 - SecretsManagerListResponse

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
secret required		array[SecretsManager]
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]

2.11 - SecretsManagerSetCidrRequest

Name	Description	Schema	Default
acl_cidr required	Secret 접근허용 CIDR 리스트 Example : `192.168.1.1/24, 10.0.0.1/16`	any of [string, null]

2.12 - SecretsManagerSetDescriptionRequest

Name	Description	Schema	Default
description required	Secret 설명 Example : `description`	any of [string, null]

2.13 - SecretsManagerSetKmsRequest

Name	Description	Schema	Default
kms_id required	Key Management Service 상품에서 생성한 자원 ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string

2.14 - SecretsManagerSetPrivateAclRequest

Name	Description	Schema	Default
private_acl_enabled optional	프라이빗 접근 제어 활성화 Example : `true`	boolean
private_acl_resources optional	프라이빗 접근 제어 자원들	any of [array[PrivateAclResourceId], null]

2.15 - SecretsManagerSetSecretValueRequest

Name	Description	Schema	Default
secret_value required	Secret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다. Example : `{"key1":"value1","key2":"value2"}`	string

2.16 - SecretsManagerShowResponse

Name	Description	Schema	Default
secret required		SecretsManager

2.17 - SecretsManagerShowResponseV1Dot1

Name	Description	Schema	Default
secret required		SecretsManagerIncludePrivateAclAndSrn

2.18 - SecretsManagerShowSecretValueRequest

Name	Description	Schema	Default
label optional	Secret 버전 라벨. 중복 불가. Example : `CURRENT` Minimum length : `1` Maximum length : `256`	string
version_id optional	Secret 버전 아이디 Example : `e7b638507d9f4feeb6032a22b7640bf7`	string

2.19 - SecretsManagerShowSecretValueResponse

Name	Description	Schema	Default
secret_value required	Secret의 Value는 key/value 형식의 json string으로 10개쌍까지 입력 가능합니다. Example : `{"key1":"value1","key2":"value2"}`	string

2.20 - SecretsManagerTerminatedRequest

Name	Description	Schema	Default
waiting_time_ndays required	삭제까지 남은 일수 Example : `7` Minimum : `7` Maximum : `30`	integer

2.21 - SecretsManagerUpdatedPrivateAclResponse

Name	Description	Schema	Default
secret required		SecretsManagerIncludePrivateAcl

2.22 - SecretsManagerUpdateLabelRequest

Name	Description	Schema
label required	Secret 버전 라벨. 중복 불가. Example : `My Custom Label` Minimum length : `1` Maximum length : `256`	string
move_to_version_id optional	Secret 버전 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	any of [string, null]
remove_from_version_id optional	Secret 버전 아이디 Example : `3265ab469f0d406d83073da3e11e7a6c`	any of [string, null]

2.23 - SecretsManagerVersionListResponse

Name	Description	Schema	Default
version_list required		array[object]

2.24 - SecretsManagerVersionListResponseV1Dot1

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
version_list required		array[object]

2.25 - SecretsRandomPasswordRequest

Name	Description	Schema	Default
exclude_characters optional	비밀번호 생성 시 제외할 문자들 Example : `abcdefg` Maximum length : `4096`	string
exclude_lowercase optional	소문자 제외 옵션 Example : `false`	boolean
exclude_numbers optional	숫자 제외 옵션 Example : `false`	boolean
exclude_punctuation optional	특수문자 제외 옵션 Example : `false`	boolean
exclude_uppercase optional	대문자 제외 옵션 Example : `false`	boolean
include_space optional	공백 포함 옵션 Example : `false`	boolean
password_length optional	생성할 비밀번호의 길이 Example : `32` Minimum : `5` Maximum : `1024`	integer	32
require_each_included_type optional	포함된 모든 문자 유형 필수 요구 Example : `true`	boolean	True

2.26 - SecretsRandomPasswordResponse

Name	Description	Schema	Default
random_password required	임의 비밀번호 생성 Example : `random-value`	string

2.27 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string