Learn R Programming
civis (version 1.1.0)

notebooks_post: Create a Notebook

Description

Create a Notebook

Usage

notebooks_post(name = NULL, language = NULL, description = NULL,
  file_id = NULL, requirements_file_id = NULL, requirements = NULL,
  docker_image_name = NULL, docker_image_tag = NULL, memory = NULL,
  cpu = NULL, credentials = NULL, git_url = NULL, git_branch = NULL,
  git_file = NULL, environment_variables = NULL, idle_timeout = NULL,
  hidden = NULL)

Arguments

name

string optional. The name of this notebook.

language

string optional. The kernel language of this notebook.

description

string optional. The description of this notebook.

file_id

string optional. The file ID for the S3 file containing the .ipynb file.

requirements_file_id

string optional. The file ID for the S3 file containing the requirements.txt file.

requirements

string optional. The requirements txt file.

docker_image_name

string optional. The name of the docker image to pull from DockerHub.

docker_image_tag

string optional. The tag of the docker image to pull from DockerHub (default: latest).

memory

integer optional. The amount of memory allocated to the notebook.

cpu

integer optional. The amount of cpu allocated to the the notebook.

credentials

array optional. A list of credential IDs to pass to the notebook.

git_url

string optional. The URL of the repository that will be cloned.

git_branch

string optional. The name of the branch that will be cloned.

git_file

string optional. The name of the notebook file within a repository that will be included in the deployment.

environment_variables

object optional. Environment variables to be passed into the Notebook.

idle_timeout

integer optional. How long the notebook will stay alive without any kernel activity.

hidden

boolean optional. The hidden status of the object.

Value

A list containing the following elements:

id

integer, The ID for this notebook.

name

string, The name of this notebook.

language

string, The kernel language of this notebook.

description

string, The description of this notebook.

notebookUrl

string, Time-limited URL to get the .ipynb file for this notebook.

notebookPreviewUrl

string, Time-limited URL to get the .htm preview file for this notebook.

requirementsUrl

string, Time-limited URL to get the requirements.txt file for this notebook.

fileId

string, The file ID for the S3 file containing the .ipynb file.

requirementsFileId

string, The file ID for the S3 file containing the requirements.txt file.

user

object, A list containing the following elements:

  • id integer, The ID of this user.

  • name string, This user's name.

  • username string, This user's username.

  • initials string, This user's initials.

  • online boolean, Whether this user is online.

dockerImageName

string, The name of the docker image to pull from DockerHub.

dockerImageTag

string, The tag of the docker image to pull from DockerHub (default: latest).

memory

integer, The amount of memory allocated to the notebook.

cpu

integer, The amount of cpu allocated to the the notebook.

createdAt

string,

updatedAt

string,

mostRecentDeployment

object, A list containing the following elements:

  • deploymentId integer, The ID for this deployment.

  • userId integer, The ID of the owner.

  • host string, Domain of the deployment.

  • name string, Name of the deployment.

  • dockerImageName string, The name of the docker image to pull from DockerHub.

  • dockerImageTag string, The tag of the docker image to pull from DockerHub (default: latest).

  • displayUrl string, URL that displays the deployed platform object and includes auth token.

  • memory integer, The memory allocated to the deployment.

  • cpu integer, The cpu allocated to the deployment.

  • state string, The state of the deployment.

  • stateMessage string, A detailed description of the state.

  • createdAt string,

  • updatedAt string,

  • published boolean,

  • notebookId integer, The ID of owning Notebook

credentials

array, A list of credential IDs to pass to the notebook.

gitUrl

string, The URL of the repository that will be cloned.

gitBranch

string, The name of the branch that will be cloned.

gitFile

string, The name of the notebook file within a repository that will be included in the deployment.

environmentVariables

object, Environment variables to be passed into the Notebook.

idleTimeout

integer, How long the notebook will stay alive without any kernel activity.

archived

string, The archival status of the requested object(s).

hidden

boolean, The hidden status of the object.