Actions¶

Actions are used to run pipelines (workflows) in repositories. Through the API you can manually trigger and rerun pipelines, view run records, jobs, and logs, manage build artifacts (artifacts), and manage the host/K8S runners that execute jobs.

The version prefix for this endpoint group is /api/v8, not the /api/v5 used by other groups.

Objects¶

Identifiers¶

• Repository-level endpoints use owner + repo; organization-level runner endpoints use org.
• workflow_id identifies a pipeline, run_id identifies a run, and job_id identifies a job within a run.
• artifact_id identifies a build artifact, and runner_group_id identifies a runner group.
• When downloading an artifact, the path also needs archive_format (such as zip).

Common tasks¶

Notes¶

• The version prefix is /api/v8: in the same set of documentation, all other groups use /api/v5, so copying paths verbatim will often fail to reach the endpoint.
• The three run-related actions have different paths and different meanings: stop stops the current run, rerun reruns the whole thing, and retry retries only the failed tasks.
• Manually triggering a pipeline uses workflows/{workflow_id}/dispatches (plural dispatches); it, along with validation endpoints such as workflows/validate, lives under workflows/.
• The step-level log endpoint is POST: POST .../runs/{run_id}/jobs/{job_id}/logs; only the full-log download is GET .../jobs/{job_id}/download_log.
• Runners have two sets of paths — host (runners) and K8S (runner-sets) — plus shared-runners / shared-runner-sets for the "shared with the repository" case.
• Organization-level runner endpoints use the prefix /api/v8/orgs/{org}/actions/…, parallel to the repository-level /api/v8/repos/{owner}/{repo}/actions/….

Endpoint list¶

This module has 27 endpoints.