---
title: "checkAvailableName"
slug: "analytics-dataforest-accounts-checkavailablename"
updated: 2026-09-17T09:57:35Z
published: 2026-09-17T09:57:35Z
canonical: "api.ncloud-docs.com/analytics-dataforest-accounts-checkavailablename"
---

> ## 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.

# checkAvailableName

VPC環境で利用できます。

Data Forestアカウント名の有効性と重複チェックを行います。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| POST | /api/v2/accounts/checkAvailableName |

### リクエストヘッダ

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

### リクエストボディ

リクエストボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `name` | String | Required | アカウント名 - 英字の小文字、数字、記号の「-」を組み合わせて2~16文字以内で入力 - 文字列の先頭文字と末尾文字は英字の小文字または数字を使用 |

### リクエスト例

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

```
curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/accounts/checkAvailableName' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "name": "forest001"
}'
```

## レスポンス

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

### レスポンスボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `success` | Boolean | - | API処理結果 - `true` \| `false` - `true`: 成功 - `false`: 失敗 |
| `message` | String | - | 結果メッセージ - `success`または`availableName`が`false`の場合、表示 |
| `availableName` | String | - | アカウント名が有効かどうか - `true` \| `false` - `true`: 有効 - `false`: 無効 |

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

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

### レスポンス例

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

```
{
    "success": true,
    "availableName": true
}
```