LogoLogo
PipekitPricingBlogPipekit StatusRelease Notes
  • Introduction
  • Getting Started
  • CLI
    • Cron Workflows
  • Pipekit Agent
    • Helm Install
  • Pipekit
    • Authentication
      • Okta
    • Runs
    • Pipes
      • Managing Pipes
        • Run Conditions
        • Secrets
        • Alerting
      • Pipe Runs
        • Run Graph (DAG)
        • Pod Logs
        • Workflow Logs
        • Workflow YAML
      • Cron Workflows
      • Externally Triggered Workflows
    • Metrics
    • Templates
    • Clusters
    • Organization
      • Creating an Organization
      • Managing Users
      • Managing Alert Providers
      • Settings
      • Permissions
  • Python SDK
    • Jupyter Notebooks
    • Python Scripts
  • Self-Hosting Pipekit
    • Dependencies and Pre-requisites
    • Container Images
    • Kubernetes Permissions
    • Self-Hosted Pipekit Helm Chart
    • License Key
    • Initial Login and Break Glass Account
    • Integrating with your Git Provider
    • Configuring SSO
  • Additional Information
    • Free Trial Cluster
  • REST API
Powered by GitBook
On this page

REST API

How to use the Pipekit REST API

Last updated 23 days ago

The Pipekit REST API allows users to submit Argo Workflow and CronWorkflow types to be run or scheduled on a given cluster that Pipekit manages. It also allows users to query the Pipekit control plane for information about the status of workflow runs and the associated pods on their clusters.

To submit a Workflow or a CronWorkflow, a user will need:

  • Their bearer token

  • The UUID of the cluster to submit to

Authentication

If you have the pipekit CLI installed, the fastest way to get the bearer token is to login with pipekit login and then get the bearer token with pipekit hera -r.

Running a Workflow

Running a CronWorkflow

List Workflow statuses on a Cluster