Skip to content

GitHub: Download job logs for a workflow run

GitHub actions.actionsDownloadJobLogsForWorkflowRun: arguments, response, policy and SDK examples.

← Actions operations · Get started

Operation github.actions_download_job_logs_for_workflow_run

Provider route: GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";
async function execute(input: Parameters<GitHubIntegration["actions"]["actionsDownloadJobLogsForWorkflowRun"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.actions.actionsDownloadJobLogsForWorkflowRun(input);
const result = await call.wait();
return result.response;
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.actions.actions_download_job_logs_for_workflow_run(arguments)
result = await call.wait()
return result.response
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.ownerstringRequired within parent
path.repostringRequired within parent
path.job_idintegerRequired within parentFormat: int64

GitHub returns a redirect (302). Alter preserves the status and response headers and does not follow the redirect. The example returns the retained response; inspect its headers for Location to obtain the download destination. Handle that destination in your application without forwarding the provider credential. There is no successful JSON response to decode.

SDK function policy ID: github.actions_download_job_logs_for_workflow_run. Catalog operation: actions/download-job-logs-for-workflow-run. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.