Orkes

Orkes Schedules API

The Schedules API from Orkes — 4 operation(s) for schedules.

GitHub OpenAPI

Operations 6

GET /scheduler/schedules List schedules #
POST /scheduler/schedules Create a schedule #
GET /scheduler/schedules/{name} Get a schedule #
DELETE /scheduler/schedules/{name} Delete a schedule #
POST /scheduler/schedules/{name}/pause Pause a schedule #
POST /scheduler/schedules/{name}/resume Resume a schedule #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/orkes/refs/heads/main/openapi/orkes-schedules-api-openapi.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/orkes-schedules-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.

OpenAPI Specification

orkes-schedules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Orkes Conductor REST Authentication Schedules API
  description: The Orkes Conductor REST API provides endpoints for managing workflows, tasks, human tasks, secrets, schedules, and other resources in the Orkes workflow orchestration platform built on Netflix Conductor.
  version: 2.0.0
  contact:
    name: Orkes
    url: https://orkes.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{baseUrl}/api'
  description: Orkes Conductor Server
  variables:
    baseUrl:
      default: https://play.orkes.io
security:
- BearerAuth: []
tags:
- name: Schedules
paths:
  /scheduler/schedules:
    get:
      operationId: listSchedules
      summary: List schedules
      description: Returns all workflow schedules.
      tags:
      - Schedules
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schedule'
    post:
      operationId: createSchedule
      summary: Create a schedule
      description: Creates a new workflow schedule.
      tags:
      - Schedules
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Schedule'
      responses:
        '200':
          description: Schedule created
  /scheduler/schedules/{name}:
    get:
      operationId: getSchedule
      summary: Get a schedule
      description: Returns a specific workflow schedule.
      tags:
      - Schedules
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
    delete:
      operationId: deleteSchedule
      summary: Delete a schedule
      description: Deletes a workflow schedule.
      tags:
      - Schedules
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Schedule deleted
  /scheduler/schedules/{name}/pause:
    post:
      operationId: pauseSchedule
      summary: Pause a schedule
      description: Pauses a workflow schedule.
      tags:
      - Schedules
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Schedule paused
  /scheduler/schedules/{name}/resume:
    post:
      operationId: resumeSchedule
      summary: Resume a schedule
      description: Resumes a paused workflow schedule.
      tags:
      - Schedules
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Schedule resumed
components:
  schemas:
    Schedule:
      type: object
      properties:
        name:
          type: string
        cronExpression:
          type: string
        startWorkflowRequest:
          $ref: '#/components/schemas/StartWorkflowRequest'
        paused:
          type: boolean
        scheduleStartTime:
          type: integer
          format: int64
        scheduleEndTime:
          type: integer
          format: int64
    StartWorkflowRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        version:
          type: integer
        correlationId:
          type: string
        input:
          type: object
        taskToDomain:
          type: object
        priority:
          type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer