How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Azure Synapse Analytics Notebook API

The Notebook API from Azure Synapse Analytics — 4 operation(s) for notebook.

Azure Synapse Analytics Notebook API is one of 35 APIs that Azure Synapse Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 11 JSON Schema definitions.

Tagged areas include Notebook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 11 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 2020-12-01.

Requests are made against a single base URL, https://{workspaceName}.dev.azuresynapse.net.

6 operations 4 paths 6 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-12-01
Base URL
https://management.azure.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Azure Synapse Analytics Notebook API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (azure_auth) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Notebook 6
GET
/notebooks
Azure Synapse Analytics List notebooks
Notebook_GetNotebooksByWorkspace 1 param → 200default
GET
/notebooks/summary
Azure Synapse Analytics List notebook summaries
Notebook_GetNotebookSummaryByWorkSpace 1 param → 200default
GET
/notebooks/{notebookName}
Azure Synapse Analytics Get a notebook
Notebook_GetNotebook 3 params → 200304default
PUT
/notebooks/{notebookName}
Azure Synapse Analytics Create or update a notebook
Notebook_CreateOrUpdateNotebook 3 params body → 200202default
DELETE
/notebooks/{notebookName}
Azure Synapse Analytics Delete a notebook
Notebook_DeleteNotebook 2 params → 200202204default
POST
/notebooks/{notebookName}/rename
Azure Synapse Analytics Rename a notebook
Notebook_RenameNotebook 2 params body → 200202default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Notebook (8 properties), NotebookResource (5 properties), NotebookCell (4 properties), NotebookListResponse (2 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property
ArtifactRenameRequest
object
1 property
Notebook
object
Notebook definition.
8 properties
NotebookListResponse
object
2 properties
NotebookResource
object
Notebook resource.
5 properties
NotebookCell
object
Notebook cell definition.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-synapse-analytics-notebook-api-openapi.yml Raw ↑

Other APIs Azure Synapse Analytics publishes across the network.

Azure Synapse Analytics AzureADOnlyAuthentications API
Azure Synapse Analytics BigDataPools API
Azure Synapse Analytics Credential API
Azure Synapse Analytics DataFlow API
Azure Synapse Analytics DataFlowDebugSession API
Azure Synapse Analytics Dataset API
Azure Synapse Analytics GitIntegration API
Azure Synapse Analytics IntegrationRuntimes API
Azure Synapse Analytics IpFirewallRules API
Azure Synapse Analytics Keys API
Azure Synapse Analytics KqlScripts API
Azure Synapse Analytics KustoPools API
Where this information came from

This is an independent, third-party profile of Azure Synapse Analytics Notebook API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.