Apache Superset Annotation Layer API

The Annotation Layer API from Apache Superset — 4 operation(s) for annotation layer.

OpenAPI Specification

apache-superset-annotation-layer-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Apache Superset REST Annotation Layer API
  version: '1.0'
  description: Minimal OpenAPI for the Apache Superset REST API covering authentication, dashboards, charts, datasets, databases, SQL Lab, queries, tags, themes, annotations, security (users/roles/permissions), reports, and assets.
servers:
- url: http://localhost:8088
  description: Superset
tags:
- name: Annotation Layer
paths:
  /api/v1/annotation_layer/:
    get:
      summary: List annotation layers
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
    post:
      summary: Create annotation layer
      responses:
        '201':
          description: Created
      tags:
      - Annotation Layer
    delete:
      summary: Bulk delete annotation layers
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
  /api/v1/annotation_layer/{pk}:
    get:
      summary: Get annotation layer
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
    put:
      summary: Update annotation layer
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
    delete:
      summary: Delete annotation layer
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
  /api/v1/annotation_layer/{pk}/annotation/:
    get:
      summary: List annotations
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
    post:
      summary: Create annotation
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
      tags:
      - Annotation Layer
    delete:
      summary: Bulk delete annotations
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
  /api/v1/annotation_layer/{pk}/annotation/{annotation_id}:
    get:
      summary: Get annotation
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      - name: annotation_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
    put:
      summary: Update annotation
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      - name: annotation_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
    delete:
      summary: Delete annotation
      parameters:
      - name: pk
        in: path
        required: true
        schema:
          type: string
      - name: annotation_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      tags:
      - Annotation Layer
x-generated-from: https://superset.apache.org/developer-docs/api
x-generated-by: claude-crawl-2026-05-08