Flyte Executions API

openapi: 3.1.0
info:
  title: Flyte Admin DataProxy Executions API
  description: The Flyte Admin API is the control-plane REST API exposed by the flyteadmin service. It is generated from the flyteidl protocol buffer definitions via gRPC-Gateway and provides JSON over HTTP access to the same operations exposed via gRPC. The API is used to register and manage projects, tasks, workflows, and launch plans, to create and inspect workflow, node, and task executions, to receive lifecycle events, to proxy data to and from upstream object stores, and to read and write matchable attribute overrides at the project, domain, and workflow levels. The same REST API powers the Flyte Console UI and is the primary programmatic interface for operating a Flyte cluster.
  version: v1
  contact:
    name: Flyte
    url: https://flyte.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:30080
  description: Default flyteadmin endpoint in a local sandbox cluster
tags:
- name: Executions
  description: Workflow execution creation, listing, retrieval, and termination.
paths:
  /api/v1/executions:
    post:
      tags:
      - Executions
      summary: Create a workflow execution
      operationId: CreateExecution
      responses:
        '200':
          description: Workflow execution created.
  /api/v1/executions/relaunch:
    post:
      tags:
      - Executions
      summary: Relaunch a workflow execution
      operationId: RelaunchExecution
      responses:
        '200':
          description: Workflow execution relaunched.
  /api/v1/executions/recover:
    post:
      tags:
      - Executions
      summary: Recover a workflow execution
      operationId: RecoverExecution
      responses:
        '200':
          description: Workflow execution recovered.
  /api/v1/executions/{id.project}/{id.domain}:
    get:
      tags:
      - Executions
      summary: List workflow executions
      operationId: ListExecutions
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A list of workflow executions.
  /api/v1/executions/{id.project}/{id.domain}/{id.name}:
    get:
      tags:
      - Executions
      summary: Retrieve a workflow execution
      operationId: GetExecution
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      - name: id.name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A workflow execution.
    delete:
      tags:
      - Executions
      summary: Terminate a workflow execution
      operationId: TerminateExecution
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      - name: id.name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Workflow execution terminated.
  /api/v1/metrics/executions/{id.project}/{id.domain}/{id.name}:
    get:
      tags:
      - Executions
      summary: Retrieve execution metrics
      operationId: GetExecutionMetrics
      parameters:
      - name: id.project
        in: path
        required: true
        schema:
          type: string
      - name: id.domain
        in: path
        required: true
        schema:
          type: string
      - name: id.name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Execution metrics.