MENU
      checkAvailableName

        checkAvailableName


        Article summary

        Available in VPC

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

        Requests

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        accountIdYESStringEnter up to 22 characters.- Account identifier UUID (base62)
        Id can be obtained through getList API in Accounts
        nameYESStringEnter 3 to 15 characters.App name

        Request headers

        See common guide.

        Request Bodies

        • JSON
          {
            "accountId": "string",
            "name": "string"
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <CheckAppAvailableNameRequest>
            <accountId>string</accountId>
            <name>string</name>
          </CheckAppAvailableNameRequest>
          XML

        Responses

        Response bodies

        • JSON
          {
            "availableName": false,
            "message": "string",
            "success": true
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <CheckAppAvailableNameResponse>
            <availableName>false</availableName>
            <message>string</message>
            <success>true</success>
          </CheckAppAvailableNameResponse>
          XML

        Errors

        See DataForest overview

        Examples

        Request examples

        • HTTP

          POST https://df.apigw.ntruss.com/api/v2/apps/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=
          {
            "accountId": "adlZem05uh2coBZJ0SOWge",
            "name": "dev24x7"
          }
          HTTP
        • BASH

          curl -X POST "https://df.apigw.ntruss.com/api/v2/apps/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 "{ "accountId": "adlZem05uh2coBZJ0SOWge", "name": "dev24x7"}" \
          Bash

        Response examples

        • HTTP

          HTTP StatusDescription
          200OK
        • BASH

          {
            "success": true,
            "message": "success",
            "availableName": true
          }
          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.