v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-11-288093493.9 MB
actions

List workflow run artifacts

Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

get/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

run_idinteger required

The unique identifier of the workflow run.

Query parameters

per_pageinteger

The number of results per page (max 100).

pageinteger

Page number of the results to fetch.

namestring

The name field of an artifact. When specified, only artifacts with this name will be returned.

Response

Response

total_countinteger required

Example response

{
  "artifacts": [
    {
      "id": 5,
      "node_id": "MDEwOkNoZWNrU3VpdGU1",
      "name": "AdventureWorks.Framework",
      "size_in_bytes": 12345,
      "url": "https://api.github.com/repos/github/hello-world/actions/artifacts/5",
      "archive_download_url": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip",
      "workflow_run": {
        "id": 10,
        "repository_id": 42,
        "head_repository_id": 42,
        "head_branch": "main",
        "head_sha": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
      }
    }
  ]
}