Flyte NodeExecutions API

Node execution listing and retrieval.

OpenAPI Specification

flyte-nodeexecutions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Flyte Admin DataProxy NodeExecutions 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: NodeExecutions
  description: Node execution listing and retrieval.
paths:
  /api/v1/node_executions/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}:
    get:
      tags:
      - NodeExecutions
      summary: List node executions for a workflow execution
      operationId: ListNodeExecutions
      parameters:
      - name: workflow_execution_id.project
        in: path
        required: true
        schema:
          type: string
      - name: workflow_execution_id.domain
        in: path
        required: true
        schema:
          type: string
      - name: workflow_execution_id.name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A list of node executions.