checkAvailableName

Prev Next

Available in VPC

Check validity and duplication status of a Data Forest account name.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v2/accounts/checkAvailableName

Request headers

For information about the headers common to all Data Forest APIs, see Data Forest request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
name String Required Account name
  • Enter 2 to 16 characters using a combination of lowercase English letters, numbers, and special character "-".
  • Start and end of the string must be composed of lowercase English letters or numbers.

Request example

The request example is as follows:

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"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API processing result
  • true | false
    • true: succeeded
    • false: failed
message String - Result message
  • If success or availableName is false, it is displayed.
availableName String - Account name validity
  • true | false
    • true: valid
    • false: invalid

Response status codes

For information about the HTTP status codes common to all Data Forest APIs, see Data Forest response status codes.

Response example

The response example is as follows:

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