Notebook

List notebooks¶

GET/api/v2/databases/{database}/schemas/{schema}/notebooks
List notebooks

Path Parameters¶

ParameterTypeDescription
databasestring
Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases.
schema
Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database.

Query Parameters¶

ParameterTypeDescription
likestring
Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWithstring
Query parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.
showLimitinteger
Query parameter to limit the maximum number of rows returned by a command.
fromNamestring
Query parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.

Response¶

CodeDescription
200
successful
[
  {
    "name": "string",
    "version": "string",
    "fromLocation": "string",
    "main_file": "string",
    "comment": "string",
    "default_version": "string",
    "query_warehouse": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "database_name": "string",
    "schema_name": "string",
    "owner": "string",
    "owner_role_type": "string",
    "url_id": "string",
    "title": "string",
    "default_packages": "string",
    "user_packages": "string",
    "runtime_name": "string",
    "compute_pool": "string",
    "import_urls": [
      "string"
    ],
    "external_access_integrations": [
      "string"
    ],
    "external_access_secrets": "string",
    "idle_auto_shutdown_time_seconds": 0,
    "default_version_details": {
      "name": "string",
      "alias": "string",
      "location_url": "string",
      "source_location_uri": "string",
      "git_commit_hash": "string"
    },
    "last_version_details": {
      "name": "string",
      "alias": "string",
      "location_url": "string",
      "source_location_uri": "string",
      "git_commit_hash": "string"
    },
    "live_version_location_uri": "string",
    "budget": "string"
  }
]
NameTypeDescription
X-Snowflake-Request-IDstringUnique ID of the API request.
LinkstringLinks to the page of results (e.g. the first page, the last page, etc.). The header can include multiple 'url' entries with different 'rel' attribute values that specify the page to return ('first', 'next', 'prev', and 'last').
202
Successfully accepted the request, but it is not completed yet.
{
  "code": "392604",
  "message": "Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management."
}
NameTypeDescription
LocationstringRelative path for checking request status or getting the result, if available.
X-Snowflake-Request-ID
400Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the request body for retry.
401Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a new access token for retry.
403Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.
404Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.
405Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.
408Request Timeout. This indicates that the request from the client timed out and was not completed by the server.
409Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the options orReplace/ifNotExists.
410Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.
429Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.
500Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.
503Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.
504Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.
ParameterTypeDescription

Create a notebook¶

POST/api/v2/databases/{database}/schemas/{schema}/notebooks
Create a notebook

Query Parameters¶

ParameterTypeDescription
createModestring
Query parameter allowing support for different modes of resource creation. Possible values include:
  • errorIfExists: Throws an error if you try to create a resource that already exists.
  • orReplace: Automatically replaces the existing resource with the current one.
  • ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.
ParameterTypeDescription
{
  "name": "string",
  "version": "string",
  "fromLocation": "string",
  "main_file": "string",
  "comment": "string",
  "default_version": "string",
  "query_warehouse": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "database_name": "string",
  "schema_name": "string",
  "owner": "string",
  "owner_role_type": "string",
  "url_id": "string",
  "title": "string",
  "default_packages": "string",
  "user_packages": "string",
  "runtime_name": "string",
  "compute_pool": "string",
  "import_urls": [
    "string"
  ],
  "external_access_integrations": [
    "string"
  ],
  "external_access_secrets": "string",
  "idle_auto_shutdown_time_seconds": 0,
  "default_version_details": {
    "name": "string",
    "alias": "string",
    "location_url": "string",
    "source_location_uri": "string",
    "git_commit_hash": "string"
  },
  "last_version_details": {
    "name": "string",
    "alias": "string",
    "location_url": "string",
    "source_location_uri": "string",
    "git_commit_hash": "string"
  },
  "live_version_location_uri": "string",
  "budget": "string"
}

Response¶

CodeDescription
200
Successful request.
{
  "status": "Request successfully completed"
}
NameType
X-Snowflake-Request-ID
202
400
401
403
404
405
408
409
410
429
500
503
504
ParameterTypeDescription
statusstringMessage returned by the server.

Fetch a notebook¶

GET/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}
Fetch a notebook

Path Parameters¶

ParameterTypeDescription
name
Identifier (i.e. name) for the resource.

Response¶

CodeDescription
200
successful
{
  "name": "string",
  "version": "string",
  "fromLocation": "string",
  "main_file": "string",
  "comment": "string",
  "default_version": "string",
  "query_warehouse": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "database_name": "string",
  "schema_name": "string",
  "owner": "string",
  "owner_role_type": "string",
  "url_id": "string",
  "title": "string",
  "default_packages": "string",
  "user_packages": "string",
  "runtime_name": "string",
  "compute_pool": "string",
  "import_urls": [
    "string"
  ],
  "external_access_integrations": [
    "string"
  ],
  "external_access_secrets": "string",
  "idle_auto_shutdown_time_seconds": 0,
  "default_version_details": {
    "name": "string",
    "alias": "string",
    "location_url": "string",
    "source_location_uri": "string",
    "git_commit_hash": "string"
  },
  "last_version_details": {
    "name": "string",
    "alias": "string",
    "location_url": "string",
    "source_location_uri": "string",
    "git_commit_hash": "string"
  },
  "live_version_location_uri": "string",
  "budget": "string"
}
NameType
X-Snowflake-Request-ID
Link
202
400
401
403
404
405
408
409
410
429
500
503
504
ParameterTypeDescription

Delete a notebook¶

DELETE/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}
Delete a notebook

Query Parameters¶

ParameterTypeDescription
ifExistsboolean
Query parameter that specifies how to handle the request for a resource that does not exist:
  • true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.
  • false: The endpoint throws an error if the resource doesn't exist.

Response¶

CodeDescription
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Execute a Notebook¶

POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:execute
Execute a Notebook

Query Parameters¶

ParameterTypeDescription
asyncExecboolean
Asynchronous execution enable/disable. Default is disable.

Response¶

CodeDescription
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Changes the name of the notebook to new name. The new identifier must be unique for the schema¶

POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:rename
Changes the name of the notebook to new name. The new identifier must be unique for the schema.

Query Parameters¶

ParameterTypeDescription
targetDatabasestring
Database of the target resource. Defaults to the source's database
targetSchemastring
Schema of the target resource. Defaults to the source's schema
targetNamestring
Name of the target resource.

Response¶

CodeDescription
200
202
400
401
403
404
405
408
409
410
429
500
503
504

Adds a LIVE version to the notebook¶

POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:add-live-version
Adds a LIVE version to the notebook

Query Parameters¶

ParameterTypeDescription
fromLastboolean
Sets the LIVE version to the LAST version of the notebook
commentstring
Sets a comment for the notebook or version of the notebook

Response¶

CodeDescription
200
202
400
401
403
404
405
408
409
410
429
500
503
504

If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository¶

POST/api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:commit
If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository

Query Parameters¶

ParameterTypeDescription
versionstring
live version of the alias
commentstring
Sets a comment for the notebook or version of the notebook

Response¶

CodeDescription
200
202
400
401
403
404
405
408
409
410
429
500
503
504
Language: English