checkAvailableName
    • PDF

    checkAvailableName

    • PDF

    Article summary

    Available in VPC

    View the name of the that can be created when creating the Notebook.

    Requests

    Request parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    nameYESStringEnter 3 to 15 characters.Notebook name

    Request headers

    See common guide.

    Request bodies

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

    Errors

    HTTP StatusDescription
    400invalid request parameters
    403not allowed to access
    404no such element
    500unexpected error

    Examples

    Request Examples

    POST https://df.apigw.ntruss.com/api/v2/notebooks/checkAvailableName
    HOST: df.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-v2: Azm1WBMWDgEONUCUbsVkB4tRIpc053uOHU8bitbQRtU=
    x-ncp-apigw-timestamp: 1658898041497
    x-ncp-iam-access-key: 17F9A6E9F72BD92ED94B
    {
      "name": "df-test"
    }
    
      curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/checkAvailableName" \
      -H "accept: application/json" \
      -H "Content-Type: application/json" \
      -H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu"\
      -H "x-ncp-apigw-timestamp: 1684389111294"\
      -H "x-ncp-apigw-signature-v2: QNRzcCz87VRhaBByb7jz8/iJ+ZyDbHZimPm6hM0Hyp8=" \
      -d "{ \"name\": \"df-test\"}"
    

    Response examples

    • HTTP

      HTTP StatusDescription
      200OK
    • BASH

      {
      "success": true,
      "availableName": true
      }
      
      {
      "success": true,
      "message": "'df-notebook' is not registrable name. already registered.",
      "availableName": false
      }
      

    Errors examples

    • HTTP

      HTTP StatusDescription
      403not allowed to access
    • BASH

      {
        "message": "resource ('string') is not allowed or not exists",
        "success": false
      }
      

    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.