Sign in
workflow-run-controller

Changed on
get/api/workflows/runs/{workflowRunId}/logs

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workflows/runs/{workflowRunId}/logs
  • Auth: none declared

Path parameters

workflowRunIdinteger required

Query parameters

forceRefreshboolean

Response

OK

workflowRunIdinteger required

The workflow run identifier

workflowNamestring required

The workflow run name

displayTitlestring

The workflow run display title

conclusion'ACTION_REQUIRED' | 'CANCELLED' | 'FAILURE' | 'NEUTRAL' | 'SUCCESS' | 'SKIPPED' | 'STALE' | 'TIMED_OUT' | 'STARTUP_FAILURE' | 'UNKNOWN'

The workflow run conclusion when available

htmlUrlstring

The HTML URL of the workflow run on GitHub

cacheHitboolean

Whether the workflow logs were already cached before this request

downloadedAtstring date-time required

When the workflow logs were downloaded and stored

totalFileCountinteger

The number of extracted log files

Example response

{
  "workflowName": "deploy"
}

Changes