MENU
      checkAvailableName

        checkAvailableName


        Article summary

        Available in VPC

        Check whether an AI workspace name can be created.

        Requests

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        accountIdYESStringEnter up to 22 characters.- Account identifier UUID (base62)
        Id can be obtained through getList API in Accounts
        nameYESString- Enter up to 15 characters.
        - It should start with a lowercase English letter. For the rest, lowercase English letters, numbers, and hyphens (-) are allowed.
        - You can't consecutively use hyphens, and it must not end with a hyphen.
        AI workspace name

        Request headers

        See common guide.

        Request bodies

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

        Responses

        Response bodies

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

        Errors

        See DataForest overview

        Examples

        Request examples

        • HTTP
          POST https://df.apigw.ntruss.com/api/v2/aiworkspaces/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": "wWwEh34wOZOgdafhe36lEO",
              "name": "workspace"
          }
          HTTP
        • BASH
          curl -X POST "https://df.apigw.ntruss.com/api/v2/aiworkspaces/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\": \"wWwEh34wOZOgdafhe36lEO\", \"name\": \"workspace\"}" \
          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.