REST API

How to use the Pipekit REST API

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

post
Body
apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Responses
200

OK

No content

post
/api/users/v1/clusters/{cluster-uuid}/workflows
200

OK

No content

Running a CronWorkflow

post
Body
apiVersionstringOptional

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstringOptional

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Responses
200

OK

No content

post
/api/users/v1/clusters/{cluster-uuid}/cron-workflows
200

OK

No content

List Workflow statuses on a Cluster

get
Responses
200

OK

No content

get
/api/users/v1/clusters/{cluster-uuid}/runs
200

OK

No content

Last updated