"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"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"
    }
}

2 - Delete Secret

2.1 - 1.0

delete /v1/secrets/{secret_id}

Description

Delete secret.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "waiting_time_ndays": 7
}

Example HTTP response

Response 204

3 - Generate Random Password

3.1 - 1.0

post /v1/secrets/random-password

Description

Generate random password.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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 = en-US",
"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"
}

4 - List Secrets

4.1 - 1.0

get /v1/secrets

Description

List secrets.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

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 Name Example : `name`	any of [string, null]	None
query	state optional	Secret State 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 = en-US",
"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"
    ]
}

5 - List Versions of Secret

5.1 - 1.0

get /v1/secrets/{secret_id}/versions

Description

List versions of secrets.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "version_list": [
        ""
    ]
}

6 - Restore Secret

6.1 - 1.0

put /v1/secrets/{secret_id}/restore

Description

Cancel process of deleting secret.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"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"
    }
}

7 - Set CIDR of Secret

7.1 - 1.0

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

Description

Edit the IP CIDR value for access control when retrieving the value of a Secret.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"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"
    }
}

8 - Set Description of Secret

8.1 - 1.0

put /v1/secrets/{secret_id}/description

Description

Set description of secret.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"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"
    }
}

9 - Set KMS ID of Secret

9.1 - 1.0

put /v1/secrets/{secret_id}/kmsid

Description

Modify the KMS ID used to encrypt the secret value.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"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"
    }
}

10 - Set Label of Version

10.1 - 1.0

put /v1/secrets/{secret_id}/label

Description

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	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"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

11 - Show Secret Detail

11.1 - 1.0

get /v1/secrets/{secret_id}

Description

Show secret detail.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"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"
    }
}

12 - Show Secret Value

12.1 - 1.0

post /v1/secrets/{secret_id}/values

Description

Show secret value.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

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

Example HTTP response

Response 200

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

13 - Update Secret Value

13.1 - 1.0

put /v1/secrets/{secret_id}/values

Description

Update secret value.

State ACTIVE (CURRENT)

Version	Supported Until
1.0	-

Parameters

Type	Name	Description	Schema	Default
path	secret_id required	Secret ID 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 = en-US",
"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"
    }
}