さくらのクラウド さくらのクラウド API ポータル クラウドマニュアルへ
API docs by Redocly

KMS/SecretManager/CloudHSM API (1.1.1)

Download OpenAPI specification:Download OpenAPI Spec (YAML)Download OpenAPI Spec (JSON)

さくらのクラウド KMS / SecretManager / CloudHSM API

cloudhsm

listCloudHSMs

Authorizations:
basicAuth
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "CloudHSMs": [
    ]
}

createCloudHSM

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (CreateCloudHSM)

Responses

Request samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

Response samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

listCloudHSMClients

Authorizations:
basicAuth
path Parameters
cloudhsm_resource_id
required
string
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "Clients": [
    ]
}

createCloudHSMClient

Authorizations:
basicAuth
path Parameters
cloudhsm_resource_id
required
string
Request Body schema: application/json
required
required
object (CreateCloudHSMClient)

Responses

Request samples

Content type
application/json
{
  • "Client": {
    }
}

Response samples

Content type
application/json
{
  • "Client": {
    }
}

readCloudHSMClient

Authorizations:
basicAuth
path Parameters
cloudhsm_resource_id
required
string
id
required
string

A unique value identifying this CloudHSMクライアント.

Responses

Response samples

Content type
application/json
{
  • "Client": {
    }
}

updateCloudHSMClient

Authorizations:
basicAuth
path Parameters
cloudhsm_resource_id
required
string
id
required
string

A unique value identifying this CloudHSMクライアント.

Request Body schema: application/json
required
required
object (CloudHSMClient)

Responses

Request samples

Content type
application/json
{
  • "Client": {
    }
}

Response samples

Content type
application/json
{
  • "Client": {
    }
}

patchCloudHSMClient

Authorizations:
basicAuth
path Parameters
cloudhsm_resource_id
required
string
id
required
string

A unique value identifying this CloudHSMクライアント.

Request Body schema: application/json
object (CloudHSMClient)

Responses

Request samples

Content type
application/json
{
  • "Client": {
    }
}

Response samples

Content type
application/json
{
  • "Client": {
    }
}

deleteCloudHSMClient

Authorizations:
basicAuth
path Parameters
cloudhsm_resource_id
required
string
id
required
string

A unique value identifying this CloudHSMクライアント.

Responses

readCloudHSM

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

Response samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

updateCloudHSM

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (CloudHSM)

Responses

Request samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

Response samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

patchCloudHSM

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
object (CloudHSM)

Responses

Request samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

Response samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

deleteCloudHSM

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

listCloudHSMPeers

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

Response samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

createCloudHSMPeer

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (CloudHSM)

Responses

Request samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

Response samples

Content type
application/json
{
  • "CloudHSM": {
    }
}

deleteCloudHSMPeer

Authorizations:
basicAuth
path Parameters
peer_id
required
string
resource_id
required
string (リソースID)

Responses

listCloudHSMLicenses

Authorizations:
basicAuth
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "Licenses": [
    ]
}

createCloudHSMLicense

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (CreateCloudHSMSoftwareLicense)

Responses

Request samples

Content type
application/json
{
  • "License": {
    }
}

Response samples

Content type
application/json
{
  • "License": {
    }
}

listCloudHSMDocuments

Authorizations:
basicAuth
path Parameters
license_resource_id
required
string
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "CloudHSMDocuments": [
    ]
}

readCloudHSMDocument

Authorizations:
basicAuth
path Parameters
id
required
string

A unique value identifying this CloudHSMドキュメント.

license_resource_id
required
string

Responses

Response samples

Content type
application/json
{
  • "Document": {
    }
}

downloadCloudHSMDocument

Authorizations:
basicAuth
path Parameters
id
required
string

A unique value identifying this CloudHSMドキュメント.

license_resource_id
required
string
Request Body schema: application/json
required
required
object (CloudHSMDocumentDownload)

Responses

Request samples

Content type
application/json
{
  • "Document": { }
}

Response samples

Content type
application/json
{}

readCloudHSMLicense

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

Response samples

Content type
application/json
{
  • "License": {
    }
}

updateCloudHSMLicense

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (CloudHSMSoftwareLicense)

Responses

Request samples

Content type
application/json
{
  • "License": {
    }
}

Response samples

Content type
application/json
{
  • "License": {
    }
}

patchCloudHSMLicense

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
object (CloudHSMSoftwareLicense)

Responses

Request samples

Content type
application/json
{
  • "License": {
    }
}

Response samples

Content type
application/json
{
  • "License": {
    }
}

deleteCloudHSMLicense

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

kms-key

listKeys

Authorizations:
basicAuth
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "Keys": [
    ]
}

createKey

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (CreateKey)

Responses

Request samples

Content type
application/json
{
  • "Key": {
    }
}

Response samples

Content type
application/json
{
  • "Key": {
    }
}

readKey

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

Response samples

Content type
application/json
{
  • "Key": {
    }
}

updateKey

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (Key)

Responses

Request samples

Content type
application/json
{
  • "Key": {
    }
}

Response samples

Content type
application/json
{
  • "Key": {
    }
}

patchKey

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
object (Key)

Responses

Request samples

Content type
application/json
{
  • "Key": {
    }
}

Response samples

Content type
application/json
{
  • "Key": {
    }
}

deleteKey

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

decryptDataWithKey

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (Key)

Responses

Request samples

Content type
application/json
{
  • "Key": {
    }
}

Response samples

Content type
application/json
{
  • "Key": {
    }
}

encryptDataWithKey

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (Key)

Responses

Request samples

Content type
application/json
{
  • "Key": {
    }
}

Response samples

Content type
application/json
{
  • "Key": {
    }
}

rotateKey

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (Key)

Responses

Request samples

Content type
application/json
{
  • "Key": {
    }
}

Response samples

Content type
application/json
{
  • "Key": {
    }
}

scheduleKeyDestruction

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (ScheduleDestructionKey)

鍵の削除をスケジュールするためのシリアライザ

Responses

Request samples

Content type
application/json
{
  • "Key": {
    }
}

Response samples

Content type
application/json
{
  • "Key": {
    }
}

changeKeyStatus

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (ChangeKeyState)

鍵の状態を変更するためのシリアライザ

Responses

Request samples

Content type
application/json
{
  • "Key": {
    }
}

Response samples

Content type
application/json
{
  • "Key": {
    }
}

secretmanager-vault

listSecretRotationSchedules

Authorizations:
basicAuth
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "SecretRotationSchedules": [
    ]
}

createSecretRotationSchedule

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (CreateSecretRotationSchedule)

Responses

Request samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

Response samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

readSecretRotationSchedule

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

Response samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

updateSecretRotationSchedule

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (SecretRotationSchedule)

Responses

Request samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

Response samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

patchSecretRotationSchedule

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
object (SecretRotationSchedule)

Responses

Request samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

Response samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

deleteSecretRotationSchedule

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

executeSecretRotation

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (SecretRotationSchedule)

Responses

Request samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

Response samples

Content type
application/json
{
  • "SecretRotationSchedule": {
    }
}

listSecretRotationScheduleHistories

Authorizations:
basicAuth
path Parameters
secret_rotation_schedule_resource_id
required
string
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "Histories": [
    ]
}

listVaults

Authorizations:
basicAuth
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "Vaults": [
    ]
}

createVault

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (CreateVault)

Responses

Request samples

Content type
application/json
{
  • "Vault": {
    }
}

Response samples

Content type
application/json
{
  • "Vault": {
    }
}

readVault

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

Response samples

Content type
application/json
{
  • "Vault": {
    }
}

updateVault

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
required
required
object (Vault)

Responses

Request samples

Content type
application/json
{
  • "Vault": {
    }
}

Response samples

Content type
application/json
{
  • "Vault": {
    }
}

patchVault

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)
Request Body schema: application/json
object (Vault)

Responses

Request samples

Content type
application/json
{
  • "Vault": {
    }
}

Response samples

Content type
application/json
{
  • "Vault": {
    }
}

deleteVault

Authorizations:
basicAuth
path Parameters
resource_id
required
string (リソースID)

Responses

listVaultSecrets

Authorizations:
basicAuth
path Parameters
vault_resource_id
required
string
query Parameters
Count
integer

Number of results to return per page.

From
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "Count": 10,
  • "From": 0,
  • "Total": 10,
  • "Secrets": [
    ]
}

createVaultSecret

新しいバージョンを作成します。シークレット値は最新を含む50世代まで保持され、より古い世代は削除されます。

Authorizations:
basicAuth
path Parameters
vault_resource_id
required
string
Request Body schema: application/json
required
required
object (CreateSecret)

Responses

Request samples

Content type
application/json
{
  • "Secret": {
    }
}

Response samples

Content type
application/json
{
  • "Secret": {
    }
}

unveilSecret

シークレット値を取得します。取得できるのは最新を含む50世代までです。

Authorizations:
basicAuth
path Parameters
vault_resource_id
required
string
Request Body schema: application/json
required
required
object (Unveil)

Responses

Request samples

Content type
application/json
{
  • "Secret": {
    }
}

Response samples

Content type
application/json
{
  • "Secret": {
    }
}