Argo Workflows API
Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. For more information, please see…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. For more information, please see https://argo-workflows.readthedocs.io/en/latest/
Endpoints 73
ArchivedWorkflowService
- GETArchivedWorkflowService_ListArchivedWorkflows
/api/v1/archived-workflows?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true&namePrefix=string&namespace=string&nameFilter=string - GETArchivedWorkflowService_ListArchivedWorkflowLabelKeys
/api/v1/archived-workflows-label-keys?namespace=string - GETArchivedWorkflowService_ListArchivedWorkflowLabelValues
/api/v1/archived-workflows-label-values?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true&namespace=string - GETArchivedWorkflowService_GetArchivedWorkflow
/api/v1/archived-workflows/:uid?namespace=string&name=string - DELETEArchivedWorkflowService_DeleteArchivedWorkflow
/api/v1/archived-workflows/:uid?namespace=string&name=string - PUTArchivedWorkflowService_ResubmitArchivedWorkflow
/api/v1/archived-workflows/:uid/resubmit - PUTArchivedWorkflowService_RetryArchivedWorkflow
/api/v1/archived-workflows/:uid/retry
ClusterWorkflowTemplateService
- GETClusterWorkflowTemplateService_ListClusterWorkflowTemplates
/api/v1/cluster-workflow-templates?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true - POSTClusterWorkflowTemplateService_CreateClusterWorkflowTemplate
/api/v1/cluster-workflow-templates - POSTClusterWorkflowTemplateService_LintClusterWorkflowTemplate
/api/v1/cluster-workflow-templates/lint - GETClusterWorkflowTemplateService_GetClusterWorkflowTemplate
/api/v1/cluster-workflow-templates/:name?getOptions.resourceVersion=string - PUTClusterWorkflowTemplateService_UpdateClusterWorkflowTemplate
/api/v1/cluster-workflow-templates/:name - DELETEClusterWorkflowTemplateService_DeleteClusterWorkflowTemplate
/api/v1/cluster-workflow-templates/:name?deleteOptions.gracePeriodSeconds=string&deleteOptions.preconditions.uid=string&deleteOptions.preconditions.resourceVersion=string&deleteOptions.orphanDependents=true&deleteOptions.propagationPolicy=string&deleteOptions.dryRun=string&deleteOptions.ignoreStoreReadErrorWithClusterBreakingPotential=true
CronWorkflowService
- GETCronWorkflowService_ListCronWorkflows
/api/v1/cron-workflows/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true - POSTCronWorkflowService_CreateCronWorkflow
/api/v1/cron-workflows/:namespace - POSTCronWorkflowService_LintCronWorkflow
/api/v1/cron-workflows/:namespace/lint - GETCronWorkflowService_GetCronWorkflow
/api/v1/cron-workflows/:namespace/:name?getOptions.resourceVersion=string - PUTCronWorkflowService_UpdateCronWorkflow
/api/v1/cron-workflows/:namespace/:name - DELETECronWorkflowService_DeleteCronWorkflow
/api/v1/cron-workflows/:namespace/:name?deleteOptions.gracePeriodSeconds=string&deleteOptions.preconditions.uid=string&deleteOptions.preconditions.resourceVersion=string&deleteOptions.orphanDependents=true&deleteOptions.propagationPolicy=string&deleteOptions.dryRun=string&deleteOptions.ignoreStoreReadErrorWithClusterBreakingPotential=true - PUTCronWorkflowService_ResumeCronWorkflow
/api/v1/cron-workflows/:namespace/:name/resume - PUTCronWorkflowService_SuspendCronWorkflow
/api/v1/cron-workflows/:namespace/:name/suspend
EventSourceService
- GETEventSourceService_ListEventSources
/api/v1/event-sources/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true - POSTEventSourceService_CreateEventSource
/api/v1/event-sources/:namespace - GETEventSourceService_GetEventSource
/api/v1/event-sources/:namespace/:name - PUTEventSourceService_UpdateEventSource
/api/v1/event-sources/:namespace/:name - DELETEEventSourceService_DeleteEventSource
/api/v1/event-sources/:namespace/:name?deleteOptions.gracePeriodSeconds=string&deleteOptions.preconditions.uid=string&deleteOptions.preconditions.resourceVersion=string&deleteOptions.orphanDependents=true&deleteOptions.propagationPolicy=string&deleteOptions.dryRun=string&deleteOptions.ignoreStoreReadErrorWithClusterBreakingPotential=true - GETEventSourceService_WatchEventSources
/api/v1/stream/event-sources/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true - GETEventSourceService_EventSourcesLogs
/api/v1/stream/event-sources/:namespace/logs?name=string&eventSourceType=string&eventName=string&grep=string&podLogOptions.container=string&podLogOptions.follow=true&podLogOptions.previous=true&podLogOptions.sinceSeconds=string&podLogOptions.sinceTime.seconds=string&podLogOptions.sinceTime.nanos=0&podLogOptions.timestamps=true&podLogOptions.tailLines=string&podLogOptions.limitBytes=string&podLogOptions.insecureSkipTLSVerifyBackend=true&podLogOptions.stream=string
EventService
- POSTEventService_ReceiveEvent
/api/v1/events/:namespace/:discriminator - GETEventService_ListWorkflowEventBindings
/api/v1/workflow-event-bindings/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true
InfoService
- GETInfoService_GetInfo
/api/v1/info - POSTInfoService_CollectEvent
/api/v1/tracking/event - GETInfoService_GetUserInfo
/api/v1/userinfo - GETInfoService_GetVersion
/api/v1/version
SensorService
- GETSensorService_ListSensors
/api/v1/sensors/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true - POSTSensorService_CreateSensor
/api/v1/sensors/:namespace - GETSensorService_GetSensor
/api/v1/sensors/:namespace/:name?getOptions.resourceVersion=string - PUTSensorService_UpdateSensor
/api/v1/sensors/:namespace/:name - DELETESensorService_DeleteSensor
/api/v1/sensors/:namespace/:name?deleteOptions.gracePeriodSeconds=string&deleteOptions.preconditions.uid=string&deleteOptions.preconditions.resourceVersion=string&deleteOptions.orphanDependents=true&deleteOptions.propagationPolicy=string&deleteOptions.dryRun=string&deleteOptions.ignoreStoreReadErrorWithClusterBreakingPotential=true - GETSensorService_WatchSensors
/api/v1/stream/sensors/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true - GETSensorService_SensorsLogs
/api/v1/stream/sensors/:namespace/logs?name=string&triggerName=string&grep=string&podLogOptions.container=string&podLogOptions.follow=true&podLogOptions.previous=true&podLogOptions.sinceSeconds=string&podLogOptions.sinceTime.seconds=string&podLogOptions.sinceTime.nanos=0&podLogOptions.timestamps=true&podLogOptions.tailLines=string&podLogOptions.limitBytes=string&podLogOptions.insecureSkipTLSVerifyBackend=true&podLogOptions.stream=string
WorkflowService
- GETWorkflowService_WatchEvents
/api/v1/stream/events/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true - GETWorkflowService_WatchWorkflows
/api/v1/workflow-events/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true&fields=string - GETWorkflowService_ListWorkflows
/api/v1/workflows/:namespace?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true&fields=string&nameFilter=string&createdAfter=string&finishedBefore=string - POSTWorkflowService_CreateWorkflow
/api/v1/workflows/:namespace - POSTWorkflowService_LintWorkflow
/api/v1/workflows/:namespace/lint - POSTWorkflowService_SubmitWorkflow
/api/v1/workflows/:namespace/submit - GETWorkflowService_GetWorkflow
/api/v1/workflows/:namespace/:name?getOptions.resourceVersion=string&fields=string&uid=string - DELETEWorkflowService_DeleteWorkflow
/api/v1/workflows/:namespace/:name?deleteOptions.gracePeriodSeconds=string&deleteOptions.preconditions.uid=string&deleteOptions.preconditions.resourceVersion=string&deleteOptions.orphanDependents=true&deleteOptions.propagationPolicy=string&deleteOptions.dryRun=string&deleteOptions.ignoreStoreReadErrorWithClusterBreakingPotential=true&force=true - GETWorkflowService_WorkflowLogs
/api/v1/workflows/:namespace/:name/log?podName=string&logOptions.container=string&logOptions.follow=true&logOptions.previous=true&logOptions.sinceSeconds=string&logOptions.sinceTime.seconds=string&logOptions.sinceTime.nanos=0&logOptions.timestamps=true&logOptions.tailLines=string&logOptions.limitBytes=string&logOptions.insecureSkipTLSVerifyBackend=true&logOptions.stream=string&grep=string&selector=string - PUTWorkflowService_ResubmitWorkflow
/api/v1/workflows/:namespace/:name/resubmit - PUTWorkflowService_ResumeWorkflow
/api/v1/workflows/:namespace/:name/resume - PUTWorkflowService_RetryWorkflow
/api/v1/workflows/:namespace/:name/retry - PUTWorkflowService_SetWorkflow
/api/v1/workflows/:namespace/:name/set - PUTWorkflowService_StopWorkflow
/api/v1/workflows/:namespace/:name/stop - PUTWorkflowService_SuspendWorkflow
/api/v1/workflows/:namespace/:name/suspend - PUTWorkflowService_TerminateWorkflow
/api/v1/workflows/:namespace/:name/terminate - GETDEPRECATED: Cannot work via HTTP if podName is an empty string. Use WorkflowLogs.
/api/v1/workflows/:namespace/:name/:podName/log?logOptions.container=string&logOptions.follow=true&logOptions.previous=true&logOptions.sinceSeconds=string&logOptions.sinceTime.seconds=string&logOptions.sinceTime.nanos=0&logOptions.timestamps=true&logOptions.tailLines=string&logOptions.limitBytes=string&logOptions.insecureSkipTLSVerifyBackend=true&logOptions.stream=string&grep=string&selector=string
SyncService
- POSTSyncService_CreateSyncLimit
/api/v1/sync/:namespace - GETSyncService_GetSyncLimit
/api/v1/sync/:namespace/:key?type=CONFIGMAP&cmName=string - PUTSyncService_UpdateSyncLimit
/api/v1/sync/:namespace/:key - DELETESyncService_DeleteSyncLimit
/api/v1/sync/:namespace/:key?type=CONFIGMAP&cmName=string
WorkflowTemplateService
- GETWorkflowTemplateService_ListWorkflowTemplates
/api/v1/workflow-templates/:namespace?namePattern=string&listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true - POSTWorkflowTemplateService_CreateWorkflowTemplate
/api/v1/workflow-templates/:namespace - POSTWorkflowTemplateService_LintWorkflowTemplate
/api/v1/workflow-templates/:namespace/lint - GETWorkflowTemplateService_GetWorkflowTemplate
/api/v1/workflow-templates/:namespace/:name?getOptions.resourceVersion=string - PUTWorkflowTemplateService_UpdateWorkflowTemplate
/api/v1/workflow-templates/:namespace/:name - DELETEWorkflowTemplateService_DeleteWorkflowTemplate
/api/v1/workflow-templates/:namespace/:name?deleteOptions.gracePeriodSeconds=string&deleteOptions.preconditions.uid=string&deleteOptions.preconditions.resourceVersion=string&deleteOptions.orphanDependents=true&deleteOptions.propagationPolicy=string&deleteOptions.dryRun=string&deleteOptions.ignoreStoreReadErrorWithClusterBreakingPotential=true
ArtifactService
- GETGet an artifact.
/artifact-files/:namespace/:idDiscriminator/:id/:nodeId/:artifactDiscriminator/:artifactName - GETGet an output artifact by UID.
/artifacts-by-uid/:uid/:nodeId/:artifactName - GETGet an output artifact.
/artifacts/:namespace/:name/:nodeId/:artifactName - GETGet an input artifact by UID.
/input-artifacts-by-uid/:uid/:nodeId/:artifactName - GETGet an input artifact.
/input-artifacts/:namespace/:name/:nodeId/:artifactName
API details
- Base URL
https://localhost:2746- Authentication
- An API key in the Authorization header
- Operations
- 73 operations on 53 pathsGET 34PUT 17POST 14DELETE 8
- Main resources
- WorkflowService 17CronWorkflowService 8ArchivedWorkflowService 7EventSourceService 7SensorService 7ClusterWorkflowTemplateService 6WorkflowTemplateService 6ArtifactService 5InfoService 4SyncService 4
- Response formats
application/json- Description format
- Swagger 2.0, API version
VERSION - Links
- OpenAPI document
- Listed from
- Argo Workflows's published OpenAPI description (argoproj/argo-workflows) (Apache-2.0)
How to test the Argo Workflows API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Argo Workflows API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “ArchivedWorkflowService_ListArchivedWorkflows” (GET /api/v1/archived-workflows?listOptions.labelSelector=string&listOptions.fieldSelector=string&listOptions.watch=true&listOptions.allowWatchBookmarks=true&listOptions.resourceVersion=string&listOptions.resourceVersionMatch=string&listOptions.timeoutSeconds=string&listOptions.limit=string&listOptions.continue=string&listOptions.sendInitialEvents=true&namePrefix=string&namespace=string&nameFilter=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Argo Workflows API?
Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. For more information, please see… It is listed under Developer tools and has 73 endpoints.
Who publishes the Argo Workflows API?
It is listed from Argo Workflows's public API description (an OpenAPI document), not published by Argo Workflows on Swastik Codes. Anyone who controls argoproj.io can claim the profile by adding a DNS TXT record.
What is the base URL of the Argo Workflows API?
Requests go to https://localhost:2746. Endpoint paths are added to this base URL.
How do I authenticate with the Argo Workflows API?
With an API key in the Authorization header.
How many endpoints does the Argo Workflows API have?
73 operations on 53 paths (34 GET, 17 PUT, 14 POST, 8 DELETE). The largest groups are WorkflowService, CronWorkflowService, ArchivedWorkflowService, EventSourceService.
Is forking the Argo Workflows API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.