MENU
      checkAvailableName

        checkAvailableName


        Article summary

        Available in VPC

        View the name of the account that can be created when creating a Data Forest account.

        Requests

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        nameYESString- Enter 2 to 16 characters
        - Include lowercase English alphabets, numbers and hyphens (-)
        Name of the account that can be created when creating a Data Forest account

        Request header

        See common guide.

        Request body

        • JSON

          {
            "name": "string"
          }
          JSON
        • XML

          <?xml version="1.0" encoding="UTF-8"?>
          <CheckAccountAvailableNameRequest>
            <name>string</name>
          </CheckAccountAvailableNameRequest>
          XML

        Responses

        Response bodies

        • JSON

          {
              "success": true,
              "availableName": true
          }
          JSON
        • XML

          <?xml version="1.0" encoding="UTF-8"?>
            <CheckAccountAvailableNameResponse>
                <success>true</success>
                <message/>
                <availableName>true</availableName>
            </CheckAccountAvailableNameResponse>
          XML

        Errors

        See DataForest overview.

        Examples

        Request examples

        • HTTP
          POST https://df.apigw.ntruss.com/api/v2/accounts/checkAvailableName
          HOST: df.apigw.ntruss.com
          Content-Type: application/json
          x-ncp-apigw-timestamp: 1505290625682
          x-ncp-iam-access-key: D78BB444D6D3C84CA38A
          x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
          {
            "name": "cloud1"
          }
          HTTP
        • BASH
          curl -X POST https://df.apigw.ntruss.com/api/v2/accounts/checkAvailableName \
          -H "accept: application/json" \
          -H "Content-Type: application/json" \
          -H "x-ncp-apigw-timestamp:1505290625682" \
          -H "x-ncp-iam-access-key:D78BB444D6D3C84CA38A" \
          -H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=" \
          -d "{ "name": "cloud1"}"
          Bash

        Response examples

        • HTTP

          HTTP StatusDescription
          200OK
        • BASH

          {
              "success": true,
              "availableName": true
          }
          JSON
          {
              "success": true,
              "message": "This account name is already in use.",
              "availableName": false
          }
          JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.