> ## Documentation Index
> Fetch the complete documentation index at: https://docs-xcor.paloaltonetworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UpdateNotebook



## OpenAPI

````yaml openapi/api_v1_config_openapi3_DOCUMENTATION_ONLY.json PUT /api/v1/config/notebooks/{slug}
openapi: 3.0.3
info:
  description: >

    The Config API provides standard HTTP/JSON REST endpoints for creating,
    reading,

    updating, deleting, and listing configurable Chronosphere resources.


    Use this link to download the raw Swagger specification:

    <a href="/api/v1/config/swagger.json">/api/v1/config/swagger.json</a>
  title: Config V1 API
  version: v1
servers:
  - url: https://{tenant}.chronosphere.io
    variables:
      tenant:
        default: tenant
        description: tenant ID assigned by the service provider
security:
  - ApiKeyAuth: []
tags:
  - name: ConfigV1
paths:
  /api/v1/config/notebooks/{slug}:
    put:
      tags:
        - Notebook
      operationId: UpdateNotebook
      parameters:
        - in: path
          name: slug
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigV1UpdateNotebookBody'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configv1UpdateNotebookResponse'
          description: A successful response containing the updated Notebook.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the Notebook because the request is invalid.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: Cannot update the Notebook because the slug does not exist.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: >-
            Cannot update the Notebook because there is a conflict with an
            existing Notebook.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
          description: An unexpected error response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
          description: An undefined error response.
components:
  schemas:
    ConfigV1UpdateNotebookBody:
      properties:
        create_if_missing:
          description: >-
            If `true`, the Notebook will be created if it does not already
            exist, identified by `slug`. If `false`, an error will be returned
            if the Notebook does not already exist.
          type: boolean
        dry_run:
          description: >-
            If `true`, validates the specified configuration without creating or
            updating the Notebook. If the specified configuration is valid, the
            endpoint returns a partial response without the Notebook. If the
            specified configuration is invalid, the endpoint returns an error.
          type: boolean
        notebook:
          allOf:
            - $ref: '#/components/schemas/configv1Notebook'
          description: The Notebook to update.
      type: object
    configv1UpdateNotebookResponse:
      properties:
        notebook:
          $ref: '#/components/schemas/configv1Notebook'
      type: object
    apiError:
      properties:
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    genericError:
      additionalProperties: true
      type: object
    configv1Notebook:
      properties:
        collection:
          allOf:
            - $ref: '#/components/schemas/configv1CollectionReference'
          description: >-
            Collection the notebook belongs to. Required if `collection_slug`
            isn't

            set.
        collection_slug:
          description: >-
            Slug of the collection the notebook belongs to. Required if
            `collection`

            isn't set.
          type: string
        created_at:
          description: >-
            Timestamp of when the Notebook was created. Cannot be set by
            clients.
          format: date-time
          readOnly: true
          type: string
        labels:
          additionalProperties:
            type: string
          description: Optional. Defines tags that add metadata about the notebook.
          type: object
        name:
          description: >-
            The name of the Notebook. You can modify this value after the
            Notebook is created.
          type: string
        notebook_json:
          description: Required raw JSON of the notebook.
          type: string
        slug:
          description: >-
            The unique identifier of the Notebook. If a `slug` isn't provided,
            one is generated based on the `name` field. You can't modify this
            field after the Notebook is created.
          type: string
        updated_at:
          description: >-
            Timestamp of when the Notebook was last updated. Cannot be set by
            clients.
          format: date-time
          readOnly: true
          type: string
      required:
        - name
      type: object
    configv1CollectionReference:
      properties:
        slug:
          type: string
        type:
          $ref: '#/components/schemas/configv1CollectionReferenceType'
      type: object
    configv1CollectionReferenceType:
      description: |-
        Type values must match entitiespb.Collection.CollectionType.

         - USER: A user's personal collection. Only notebooks and dashboards can be owned by a user collection; other entity types, Grafana dashboards included, reject a USER owner with a 400.
      enum:
        - SIMPLE
        - SERVICE
        - USER
      type: string
  securitySchemes:
    ApiKeyAuth:
      description: Chronosphere API token
      in: header
      name: API-Token
      type: apiKey

````

## Related topics

- [Use notebooks to gather related information](https://docs-xcor.paloaltonetworks.com/navigate/notebooks.md)
- [CreateNotebook](https://docs-xcor.paloaltonetworks.com/tooling/api-info/definition/operations/CreateNotebook.md)
- [ReadNotebook](https://docs-xcor.paloaltonetworks.com/tooling/api-info/definition/operations/ReadNotebook.md)
- [ListNotebooks](https://docs-xcor.paloaltonetworks.com/tooling/api-info/definition/operations/ListNotebooks.md)
- [DeleteNotebook](https://docs-xcor.paloaltonetworks.com/tooling/api-info/definition/operations/DeleteNotebook.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.