create

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Create a notebook.

Requests

Request parameters

Parameter name	Required	Type	Restrictions	Description
accountId	YES	String		- Account identifier UUID (base62) - accountId can be obtained through the getList API fo Accounts
addStorage	YES	Boolean	When true, storageType and storageGB must be entered	- Whether to use separate Block Storage Default: false
bucketName	Yes	String		- Bucket name - It refers to the space for saving data in Object Storage - Integrate with unlocked buckets - Integrated buckets can't be locked afterward
loginKeyName	YES	String		- loginKeyName can be obtained through the getLoginKeyList API of Notebooks
name	YES	String	Minimum of 3 characters and maximum of 15 characters Consist only of English letters (lowercase), numbers, and hyphens ("-") The first character must be an English letter, and the last character must be an English letter or a number	- Notebook name - It can't be duplicated
serverTypeCode	YES	String		- serverTypeCode; check through the getServerTypeList API of Notebooks
storageGB	NO	Integer	Only 100 to 2000, 4000, or 6000 can be entered	- Size of the additional Block Storage
storageType	NO	String		- Additional Block Storage type Options: SSD \| HDD Default: SSD
subnetNo	YES	Integer		- subnetNo can be checked through the getSubnetList API of Notebooks
typeCode	YES	String		- typeCode can be checked through the getTypeList API of Notebooks
typeName	YES	String		- typeName can be checked through the getTypeList API of Notebooks
userConfigurations	YES	String		- userConfigurations can be checked through the getUserConfigurationSpecList API of Notebooks
vpcNo	YES	Integer		- vpcNo can be checked through the getVpcList API of Notebooks

Request headers

See the common guide

Request body

JSON

{
  "accountId": "string",
  "addStorage": false,
  "loginKeyName": "string",
  "name": "string",
  "serverTypeCode": "string",
  "storageGB": 0,
  "storageType": "string",
  "subnetNo": 0,
  "typeCode": "string",
  "typeName": "string",
  "userConfigurations": [
    {
      "componentName": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "vpcNo": 0
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<CreateNotebookRequest>
  <accountId>string</accountId>
  <addStorage>true</addStorage>
  <loginKeyName>string</loginKeyName>
  <name>string</name>
  <serverTypeCode>string</serverTypeCode>
  <storageGB>0</storageGB>
  <storageType>string</storageType>
  <subnetNo>0</subnetNo>
  <typeCode>string</typeCode>
  <typeName>string</typeName>
  <userConfigurations>
    <componentName>string</componentName>
    <name>string</name>
    <value>string</value>
  </userConfigurations>
  <vpcNo>0</vpcNo>
</CreateNotebookRequest>

Responses

Response body

JSON

{
  "id": "string",
  "message": "string",
  "success": true
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<CreateNotebookResponse>
  <id>string</id>
  <message>string</message>
  <success>true</success>
</CreateNotebookResponse>

Errors

See Data Forest overview

Examples

Request example

HTTP

POST https://df.apigw.ntruss.com/api/v2/notebooks/create
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": "6COytUeFjA7b8eOhqdL5zL",
    "addStorage": false,
    "loginKeyName": "user-api-key",
    "name": "api-notebook",
    "serverTypeCode": "SVR.DFRNT.STAND.C004.M016.HDD.B050.G002",
    "subnetNo": 83356,
     "typeCode": "SW.DFRNT.OS.LNX64.CNTOS.0708.B050",
    "typeName": "Jupyter Lab",
     "userConfigurations": [
            {
            "name": "Access Password",
            "value": "testTest123@",
            "componentName": "Jupyter Lab",
            "regularExpression": "^(?=.*[0-9])(?=.*[a-zA-Z])(?=.*[!@#$%^+\\-=]).{8,20}$",
            "isMasking": true,
            "isMandatory": true
            }
         ],
    "vpcNo": 34754
 }

BASH

curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/create" \
-H "accept: application/json" -H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \
-H "x-ncp-apigw-timestamp: 1685414533742" \
-H "x-ncp-apigw-signature-v2: h4OnKdkbBcxSfc1w02qCLdSX/cFWdqwZUE57jVQYcSA=" \
-d "{ \"accountId\": \"6COytUeFjA7b8eOhqdL5zL\", 
    \"addStorage\": false,
    \"loginKeyName\": \"user-api-key\", 
    \"name\": \"api-notebook\", 
    \"serverTypeCode\": \"SVR.DFRNT.STAND.C004.M016.HDD.B050.G002\",
    \"subnetNo\": 83356, \"typeCode\": \"SW.DFRNT.OS.LNX64.CNTOS.0708.B050\", 
    \"typeName\": \"Jupyter Lab\", 
    \"userConfigurations\": [ { \"name\": \"Access Password\", \"value\": \"testTest123@\", \"componentName\": \"Jupyter Lab\", \"regularExpression\": \"^(?=.*[0-9])(?=.*[a-zA-Z])(?=.*[!@#$%^+\\\\-=]).{8,20}$\", \"isMasking\": true, \"isMandatory\": true } ], 
    \"vpcNo\": 34754 }"

Response example

HTTP
HTTP Status Description
200 OK

HTTP Status	Description
200	OK

BASH

  {
      "success": true,
      "id": "8xCT2TqPHPlakNZztTf3qx"
  }

Error code example

HTTP
HTTP Status Description
403 not allowed to access

HTTP Status	Description
403	not allowed to access

BASH

  {
      "message": "invalid request parameter (constraint violation Not available, notebook user configuration 'Jupyter Lab.Access Password')",
      "success": false
  }

Was this article helpful?

What's Next

setUserConfigurationList

Table of contents

Requests
Responses
Errors
Examples