Apache DolphinScheduler REST API

aid: apache-dolphinscheduler:apache-dolphinscheduler-rest-api
name: Apache DolphinScheduler REST API
description: The DolphinScheduler REST API enables programmatic management of projects, workflow definitions
  (DAGs), workflow instances, task types, schedules, resources, data sources, alerts, tenants, and users.
  Authentication is via API token. A Swagger UI is available at /dolphinscheduler/swagger-ui/index.html.
humanURL: https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/open-api.html
tags:
- Alerts
- DAG
- Data Sources
- Projects
- REST
- Resources
- Scheduling
- Tasks
- Tenants
- Workflow
properties:
- type: Documentation
  url: https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/open-api.html
- type: GettingStarted
  url: https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/start/quick-start.html
- type: GitHubRepository
  url: https://github.com/apache/dolphinscheduler
- type: SDKs
  url: https://pypi.org/project/apache-airflow-providers-apache-dolphinscheduler/
  title: Python SDK (PyDolphinScheduler)
- type: Tools
  url: https://hub.docker.com/r/apache/dolphinscheduler-standalone-server
  title: Docker Image
- type: Tools
  url: https://github.com/apache/dolphinscheduler-operator
  title: Kubernetes Operator
- type: JSONSchema
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-schema/apache-dolphinscheduler-schedule-schema.json
  title: Schedule
- type: JSONSchema
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-schema/apache-dolphinscheduler-task-definition-schema.json
  title: Task Definition
- type: JSONSchema
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-schema/apache-dolphinscheduler-workflow-definition-schema.json
  title: Workflow Definition
- type: JSONSchema
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-schema/apache-dolphinscheduler-workflow-instance-schema.json
  title: Workflow Instance
- type: JSONStructure
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-schedule-structure.json
- type: JSONStructure
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-task-definition-structure.json
- type: JSONStructure
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-workflow-definition-structure.json
- type: JSONStructure
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-workflow-instance-structure.json
- type: JSONLD
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-ld/apache-dolphinscheduler-context.jsonld
- type: Examples
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/examples/apache-dolphinscheduler-schedule-example.json
- type: Examples
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/examples/apache-dolphinscheduler-task-definition-example.json
- type: Examples
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/examples/apache-dolphinscheduler-workflow-definition-example.json
- type: Examples
  url: https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/examples/apache-dolphinscheduler-workflow-instance-example.json