Skip to main content
In this guide, you’ll learn how to automate the retrieval of GitHub Actions workflow logs and job metadata using GitHub’s REST API. While the GitHub Actions UI lets you download logs manually, the REST endpoints enable seamless integration in CI/CD pipelines, monitoring tools, and other automation workflows.
The image shows a webpage from GitHub Docs detailing REST API endpoints for workflow jobs in GitHub Actions, including information on how to interact with workflow jobs and a code sample for getting a job for a workflow run.

​
1. Fetch a Specific Job’s Details

Use this endpoint to get metadata and step-level statuses for a particular job in a workflow run:
Replace OWNER, REPO, and JOB_ID with your repository owner, name, and the numeric job ID.
If you’re querying a public repository, you can omit the Authorization header.
Sample response excerpt:
The image shows a GitHub Actions interface with a failed debug job, highlighting steps in a workflow, including a failed step for printing a username.

​
2. Download Raw Logs for a Single Job

Once you know the JOB_ID, fetch its logs as a ZIP archive:
  • -k skips SSL validation (only use in controlled environments).
  • -o job_logs.zip writes the output to a file.
Unzip and inspect:
Each file or folder in job_logs corresponds to individual steps and runner logs.
Avoid using -k in production—always validate SSL certificates to secure your data in transit.

​
3. Generate a GitHub Personal Access Token

For private repositories, set up a Personal Access Token (PAT) with the minimal scopes:
  1. Navigate to Settings → Developer settings → Personal access tokens → Tokens (classic).
  2. Click Generate new token, add a descriptive note and expiration.
  3. Select repo and workflow scopes.
  4. Copy the token; use it as Authorization: Bearer <YOUR_TOKEN>.
The image shows a GitHub page for creating a new personal access token, with options to set a note, expiration, and select scopes for the token.

​
4. Download Logs for an Entire Workflow Run

To grab logs for every job in a workflow run, hit the run-level endpoint:
  • Replace RUN_ID with the numeric workflow run ID.
  • The ZIP contains logs for all jobs in the specified run.
The image shows a GitHub documentation page about REST API endpoints for workflow runs, detailing how to interact with workflow runs in GitHub Actions.
After downloading:

​
Quick Reference: GitHub Actions Logs Endpoints

​
Conclusion

Automating the download and inspection of GitHub Actions logs with the REST API helps integrate build insights into custom dashboards, alerts, and other tools. Always follow best practices for token security and grant only the required scopes.

Watch Video