---
title: "createLoginKey"
slug: "compute-vserver-server-loginkey-createloginkey"
tags: ["Server"]
updated: 2026-09-17T09:57:39Z
published: 2026-09-17T09:57:39Z
canonical: "api.ncloud-docs.com/compute-vserver-server-loginkey-createloginkey"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# createLoginKey

VPC環境で利用できます。

サーバインスタンス(VM)に SSH接続する際に使用する認証キー(LoginKey)を作成します。認証キーは公開鍵(Public key)と秘密鍵(Private key)のペアで構成され、レスポンス結果に認証キー名と秘密鍵の値が返されます。秘密鍵を使用して、サーバ接続に使用する管理者パスワードを確認することができます。秘密鍵は、レスポンス結果に最初に発行された後に再度確認することができないため、安全に別途保存します。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET \| POST | /vserver/v2/createLoginKey |

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

### リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、[Serverのリクエストヘッダ](/docs/ja/compute-vserver#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | リージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - 照会結果の最初のリージョン(デフォルト) |
| `keyName` | String | Optional | 認証キー名 - 入力しないと自動作成 (デフォルト) - 英字の小文字、数字、記号の「-」を組み合わせて3~30文字以内で入力 - 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用 |
| `responseFormatType` | String | Optional | レスポンスデータの形式 - `xml`(デフォルト) \| `json` |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/createLoginKey
?regionCode=KR
&keyName=test-***
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `createLoginKeyResponse` | Object | - | レスポンス結果 |
| `createLoginKeyResponse.keyName` | String | - | 認証キー名: [KeyName](/docs/ja/common-vapidatatype-keyname)を参照 |
| `createLoginKeyResponse.privateKey` | String | - | 秘密鍵: [PrivateKey](/docs/ja/common-vapidatatype-privatekey)を参照 |
| `createLoginKeyResponse.requestId` | String | - | リクエスト ID - UUID形式 |
| `createLoginKeyResponse.returnCode` | String | - | レスポンスコード |
| `createLoginKeyResponse.returnMessage` | String | - | レスポンスメッセージ |

### レスポンスステータスコード

Server APIで共通して使用されるレスポンスステータスコードの詳細は、[Serverのレスポンスステータスコード](/docs/ja/compute-vserver#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

```
{
    "createLoginKeyResponse": {
        "keyName": "test-***",
        "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAzbhX0SkB+N3y...ztJreCiOl7hBaFqezYdQHughrPA==\n-----END RSA PRIVATE KEY-----",
        "requestId": "71d2d438-18eb-400c-a65d-626601edafcc",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
```