Apache DolphinScheduler

Apache DolphinScheduler REST API

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.

GitHub

Documentation

📖
Documentation
https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/open-api.html
📖
GettingStarted
https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/start/quick-start.html

SDKs

📦
GitHubRepository
https://github.com/apache/dolphinscheduler

Schemas & Data

📊
JSONSchema
Schedule
📊
JSONSchema
Task Definition
📊
JSONSchema
Workflow Definition
📊
JSONSchema
Workflow Instance
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-schedule-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-task-definition-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-workflow-definition-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-structure/apache-dolphinscheduler-workflow-instance-structure.json

Other Resources

🔗
SDKs
Python SDK (PyDolphinScheduler)
🔗
Tools
Docker Image
🔗
Tools
Kubernetes Operator
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/json-ld/apache-dolphinscheduler-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/examples/apache-dolphinscheduler-schedule-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/examples/apache-dolphinscheduler-task-definition-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/examples/apache-dolphinscheduler-workflow-definition-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/examples/apache-dolphinscheduler-workflow-instance-example.json
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/apache-dolphinscheduler/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/apache-dolphinscheduler-rest-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

API entry from apis.yml

apis.yml Raw ↑ 
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
- Project
- REST
- Resources
- Scheduling
- Task
- Tenants
- Workflows
tags_raw:
- 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